Skip to content

atomikui/atomikui-core

Repository files navigation

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.

// NPM
npm install --save @atomikui/core

// Yarn
yarn add @atomikui/core

2. Import the Component library CSS

Import the Atomik UI library core CSS.

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 Section.

To use the @atomikui/core-sass package in your projects CSS:


// npm
npm install @atomikui/core-sass;

// Yarn
yarn add @atomikui/core-sass;
@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.

import { FormField, CheckOption, Dropdown } from '@atomikui/core';

Release Notes

Recently updated? Check out the Release Notes.


License

Atomik UI is licensed under the terms of the MIT license.


Atomik UI Maintainers

Credit

  • Atomik UI Logo - atom by Marta Ambrosetti from the Noun Project