@geops/geops-ui

[![npm](https://img.shields.io/npm/v/react-spatial.svg?style=flat-square)](https://www.npmjs.com/package/react-spatial) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/pr

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@geops/geops-ui
0.1.189 months ago3 years agoMinified + gzip package size for @geops/geops-ui in KB

Readme

geops-ui
npm code style: prettier
This library provides the geOps Styleguide with a material-ui theme, custom material-ui components, a stylesheet, and images.
Documentation and examples at https://ui.geops.de/.
Visit 404.html for a static "Not found" page and modify the back link at the bottom respectively.

Getting Started

Install the geops-ui package:
yarn add @geops/geops-ui

Import e.g. the theme, header, footer, an image, and the stylesheet (available as scss and css) in your project:
import { geopsTheme, Header, Footer, GeopsLogoLargeSVG } from '@geops/geops-ui';

import '@geops/geops-ui/geops-ui.scss';
// Alternatively
import '@geops/geops-ui/geops-ui.css';

Run demonstration (examples)

Clone the project and run:
yarn install
yarn start

Notes

SVGs (e.g. in the Header and Footer) may not load properly depending on the webpack configuration. This can be fixed by adding a loader rule in webpackConfig using file-loader:
{
  webpackConfig: {
    module: {
      rules: [
        {
          test: /^((?!url).)*\.svg$/,
          include: [
            path.resolve(__dirname, 'node_modules', '@geops', 'geops-ui'), // Load geops-ui SVGs using file-loader
          ],
          use: [
            {
              loader: 'file-loader',
              options: {
                jsx: true,
              },
            },
          ],
        },
      ]
    }
  }
}

More