Neatly Packaged Magic

    @epignosis_llc/gnosis
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.3 • Public • Published

    Gnosis

    Epignosis official react design system.

    An internal, opinionated UI library. Primary focus is to provide a consisted and unified UI, UX and accessibility across our products.

    📦 Installation

    $ npm i @epignosis_llc/gnosis
    
    $ yarn add @epignosis_llc/gnosis
    

    The recomended font family is the "Mulish", Arial, sans-serif so please don't forget to include it (of course you can change the default font family by customizing the theme - more information below).

    Please note that react >= 16.0.0 and react-dom >= 16.0.0 are peer dependencies. Also that emotion 11 is being used and that will not work in older emotion projects.

    🔨 Usage

    Start by wrapping your App with ThemeProvider component (see example below). All the other components MUST be into the ThemeProvider in order to get the appropriate theme context.

    import { ThemeProvider, Button } from "@epignosis_llc/gnosis";
    
    function App() {
      return (
        <ThemeProvider>
          <Button>My Button</Button>
        </ThemeProvider>
      );
    }

    To view all the available props of each component clone the current repo and run npm install to install all the dependencies and then npm start to view all the components in Storybook with all their available props.

    Theme

    You can either use gnosis theme default theme (colors, fonts, etc.) or customize it to fit your project needs. This section describes the various options you can use to modify it.

    🌍 Globals

    You can add global styles by providing serialized styles like the example below:

    const globalStyles = {
      "html, body": {
        background: "red",
      },
      h1: {
        fontSize: "5rem",
        textAlign: "center",
      },
      "#my-id": {
        color: "green",
      },
      ".my-css-class": {
        color: "blue",
      },
    };
    
    <ThemeProvider globalStyles={globalStyles}></ThemeProvider>;

    🛠 Theme config

    You can also apply your own brand and colors simply by providing a new color theme. Just locate the component's theme configuration you need to change - the example below is for changing the success button colors - and create an object with your new values. The new theme configuration will be merged with the default theme, and the final merged theme will apply all the new values to the success button (or any other component). The default theme's configuration files are located in ./src/theme/default/config/ directory - for example the Button component's default theme is the ./src/theme/default/config/button.ts. Have a look at the default theme's configuration and create / configure your new custom theme.

    const myCustomTheme = {
      button: {
        success: {
          default: {
            background: "pink",
            borderColor: "red",
            color: "white",
          },
          hover: {
            background: "red",
            borderColor: "pink",
            color: "white",
          },
          active: {
            background: "red",
            borderColor: "pink",
            color: "white",
          },
        },
      },
    };
    
    <ThemeProvider theme={myCustomTheme}></ThemeProvider>;

    Icons

    You can use epignosis custom Svg icons like this:

    import { HomeSVG, CalendarSVG, HelpSVG } from "@epignosis_llc/gnosis/icons";
    
    <HomeSVG height={32} />
    <CalendarSVG height={32} />
    <HelpSVG height={32} />

    You can view all the available icon names at gnosis/src/icons/index.ts or by checking the appropriate storybook page.

    Upcoming components

    • [ ] MultiSelect
    • [ ] Table
    • [ ] DateInput
    • [ ] FileInput

    Install

    npm i @epignosis_llc/gnosis

    DownloadsWeekly Downloads

    155

    Version

    3.0.3

    License

    MIT

    Unpacked Size

    7.37 MB

    Total Files

    1436

    Last publish

    Collaborators

    • tsevdos
    • maryxan
    • epignosis_it