Package Exports

@orfium/ictinus

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@orfium/ictinus) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Ictinus

A React UI kit library with custom components that fits Orfium products internally.

npm

📦 Installation

$ npm install @orfium/ictinus

$ yarn add @orfium/ictinus

🔨 Usage

Start by wrapping your App with ictinus ThemeProvider component like below

import { ThemeProvider } from '@orfium/ictinus';

const App = () => (
    <ThemeProvider>
       <Router>
         ...
       </Router
    </ThemeProvider>
)

That's it, now you are ready to go.

import { Select, Button } from '@orfium/ictinus';

✨ Extra

Theme usage

Now you can can have access to the library's theme config by using the hook provided

import { useTheme } from '@orfium/ictinus';

const theme = useTheme();

Theme config

You can apply your own branded colours for each product at the definition of the ThemeProvider. This way you can have access everywhere.

<ThemeProvider
    theme={{
        palette: {
            branded1: theme.colors.orange,
            branded2: theme.colors.ciel,
        },
    }}
>
    ...
</ThemeProvider>