iris-dev

Iris

Quickly build React apps with Clear Channel Outdoor's Iris design system. This library extends MUI and includes design tokens and components for rapid development of beautiful, consistent and accesible apps.

Review the documentation for more information including package usage, component and design token reference, styling considerationsion and examples.

Quick Start

Install the package.

npm install @clearchannel/iris

Wrap your app in a <CCOThemeProvider> component to inherit Iris theming for your app and begin using Iris components.

// App.js

import { CCOThemeProvider, Button } from '@clearchannel/iris'

const App = () => (
  <CCOThemeProvider>
    <Button>My Button</Button>
  </CCOThemeProvider>
)

export default App

Local Development

Start a local Iris Storybook, with hot-reloading at localhost:6006.

npm run storybook

For running Storybook the first time, you must build all of the logo and icon components:

npm run svgr