https://github.com/orfium/orfium-ictinus

This repo will include the building blocks to create the Orfium Parthenons to come ...
https://github.com/orfium/orfium-ictinus

design-system ds javascript react react-components storybook typescript

Last synced: 5 days ago
JSON representation

This repo will include the building blocks to create the Orfium Parthenons to come ...

• Host: GitHub
• URL: https://github.com/orfium/orfium-ictinus
• Owner: Orfium
• Created: 2020-03-26T09:24:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T13:13:41.000Z (6 months ago)
• Last Synced: 2024-05-23T08:37:06.127Z (6 months ago)
• Topics: design-system, ds, javascript, react, react-components, storybook, typescript
• Language: TypeScript
• Homepage: https://designlab.orfium.com
• Size: 16 MB
• Stars: 21
• Watchers: 5
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Ictinus

An internal UI kit library that is opinionated. Primary focus is to solve UI duplications and provide a unified and cross product UX, UI and accessibility.



![npm](https://img.shields.io/npm/v/@orfium/ictinus)

[![pan](https://github.com/Orfium/orfium-ictinus/workflows/CI/badge.svg)](https://github.com/Orfium/orfium-ictinus/actions)

![min size](https://img.shields.io/bundlephobia/min/@orfium/ictinus)

![minzip size](https://img.shields.io/bundlephobia/minzip/@orfium/ictinus)

## 📦 Installation

```text

$ npm install @orfium/ictinus

```

```text

$ yarn add @orfium/ictinus

```

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.

if you want the next version you can always use the next tag.

Remember: this is a release candidate, we encourage you to lock version on installation to avoid any changes

```text

$ yarn add @orfium/ictinus@next

```

## 🔨 Usage

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

```jsx

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

const App = () => (

  

    ...

  

);

```

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

```js

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.

```

    ...

```

### Emotion Project - Merge theme configs from different providers

If you are already using emotion and you have defined a different provider you still have to define Ictinus ThemeProvider as well. You must put the theme config example at the top of the providers and yours afterwards.

Then you must use the below function to create a new theme config for the second provider

```

export const defaultTheme = (ancestorTheme: IctinusTheme) => ({

  ...ancestorTheme,

  ...theme,

});

```

The final outcome will look like this.

```

  

    ....

  

```