https://github.com/odeum/odeum-ui

ODEUM UI are a collection of simple visual component primitives build for ODEUM Code. All components are build with styled-components
https://github.com/odeum/odeum-ui

primitives react reactjs reactui ui ui-components

Last synced: 2 months ago
JSON representation

ODEUM UI are a collection of simple visual component primitives build for ODEUM Code. All components are build with styled-components

• Host: GitHub
• URL: https://github.com/odeum/odeum-ui
• Owner: odeum
• License: mit
• Created: 2017-10-10T23:23:10.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-29T12:27:46.000Z (over 6 years ago)
• Last Synced: 2025-03-18T10:51:33.041Z (7 months ago)
• Topics: primitives, react, reactjs, reactui, ui, ui-components
• Language: JavaScript
• Homepage:
• Size: 433 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

          


  



ODEUM UI are a React UI primitives component library build for [ODEUM Code](https://github.com/odeum/odeum-code). ODEUM UI can be utilized without ODEUM Code usage. Check the /examples folder for component demoes.

[![Build Status](https://travis-ci.org/odeum/odeum-ui.svg?branch=master)](https://travis-ci.org/odeum/odeum-ui)

[![npm](https://img.shields.io/npm/v/odeum-ui.svg)](https://www.npmjs.com/package/odeum-ui)

![NPM license](https://img.shields.io/npm/l/odeum-ui.svg?style=flat)

- [1. Components](#1-components)

- [2. Installation](#2-installation)

- [3. Usage](#3-usage)

# 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

```sh

npm install odeum-ui

yarn add odeum-ui

```

# 3. Usage

```js

import React from 'react'

import { 

	Button, 

	ButtonPanel, 

	Icon, 

	Modal, 

	ToggleSwitch } from 'odeum-ui'

...

```