Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atomikui/atomikui-core
A Library of Accessible React Components for Rapid Application Development
https://github.com/atomikui/atomikui-core
babel component-architecture component-library css3 enzyme es6 html5 javascript jest npm npm-package react styleguidist
Last synced: about 1 month ago
JSON representation
A Library of Accessible React Components for Rapid Application Development
- Host: GitHub
- URL: https://github.com/atomikui/atomikui-core
- Owner: atomikui
- License: mit
- Created: 2020-03-19T13:39:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-07T15:50:40.000Z (over 3 years ago)
- Last Synced: 2024-11-08T08:26:08.226Z (about 2 months ago)
- Topics: babel, component-architecture, component-library, css3, enzyme, es6, html5, javascript, jest, npm, npm-package, react, styleguidist
- Language: JavaScript
- Homepage: https://www.atomikui.com
- Size: 102 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
ATOMIK UI
Atomik UI is a library of accessible React components for rapid application development. From form controls to informational components like modals, alerts and toast notifications, you'll find everything you need here to get your next project off the ground.
### Features
Atomik UI comes with a variety of customizable React components to suit any development need:
- Containers
- Content
- Data Display
- Form Controls
- Informational
- Layout
- Navigational
- Templates
### Setup
#### 1. Install the component library
Install the core Atomik UI module as a production dependency.
```markup
// NPM
npm install --save @atomikui/core
// Yarn
yarn add @atomikui/core
```
#### 2. Import the Component library CSS
Import the Atomik UI library core CSS.
```js static
import '@atomikui/core/dist/styles/main.min.css';
```
#### 3. Install and Import @atomikui/core-sass abstracts (Optional)
The Atomik UI Core Sass package is the backbone of the Atomik UI Component library theme. It contains functions, mixins, variables and 192 colors that can be used in you project.
More information is available under the [Sass Utilities](https://www.atomikui.com/#/Sass%20Utilities) Section.
To use the [@atomikui/core-sass](https://www.npmjs.com/package/@atomikui/core-sass) package in your projects CSS:
```markup
// npm
npm install @atomikui/core-sass;
// Yarn
yarn add @atomikui/core-sass;
```
```css
@import 'node_modules/@atomikui/core-sass/abstracts';
```
#### 4. Begin Importing Components
It is recommended to import components as needed instead of importing the whole Atomik UI.
```js static
import { FormField, CheckOption, Dropdown } from '@atomikui/core';
```
### Release Notes
Recently updated? Check out the [Release Notes](https://github.com/atomikui/atomikui-core/releases).
### License
Atomik UI is licensed under the terms of the [MIT license](https://github.com/atomikui/atomikui-core/blob/master/LICENSE).
### Atomik UI Maintainers
- Alan Eicker [[email protected]](mailto:[email protected])
### Credit
- Atomik UI Logo - atom by Marta Ambrosetti from the Noun Project