Skip to content

Latest commit

 

History

History
executable file
·
60 lines (46 loc) · 1.64 KB

README.md

File metadata and controls

executable file
·
60 lines (46 loc) · 1.64 KB
ODEUM Code UI Primitives

ODEUM UI are a React UI primitives component library build for ODEUM Code. ODEUM UI can be utilized without ODEUM Code usage. Check the /examples folder for component demoes.

Build Status npm NPM license

1. Components

ODEUM UI primitives (odeum-ui) are a collection of simple visual components build for ODEUM Code open source UI framework. All components are build with styled-components and ReactJS and the following components will be added:

  • Button - Button component
  • ButtonPanel - Button panel for wrapping and aligning multiple buttons in a row or a column
  • Icon - Icon helper component, uses material-design icons from react-icons
  • Modal - Styled modal window based upon react-modal
  • ToggleSwitch - styled as a toggle switch
  • Checkbox (in the lab)
  • Radiobutton (in the lab)
  • OnOff - (in the lab) ...

2. Installation

npm install odeum-ui
yarn add odeum-ui

3. Usage

import React from 'react'
import { 
	Button, 
	ButtonPanel, 
	Icon, 
	Modal, 
	ToggleSwitch } from 'odeum-ui'

...

<Button
  label={'Open Modal'}
  icon='open_in_new'
  iconSize={18}
  color={'#3B97D3'}
  onClick={this.openModal}
/>