@orfium/ictinus

Ictinus

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

---

📦 Installation

$ npm install @orfium/ictinus

$ yarn add @orfium/ictinus

🔨 Usage

1. Start by wrapping your App with ictinus ThemeProvider component like below

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

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

1. 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>