1.2.2 • Published 5 years ago

atomic10-components v1.2.2

Weekly downloads
32
License
-
Repository
github
Last release
5 years ago

Atomic10 Components

Atomic10 is a React component library with clean, contemporary, and customizable components. New components will be created and added with future updates.

NPM Version NPM Download

Install

Atomic10 components are simple to install and use.

npm i atomic10-components

Usage

Interactive Component Storybook Environment:

https://atomic10-storybook.jamesonb.com

Components:

Primary Button
Secondary Button

Text Input
Dropdown
Toggle Switch

Simple Card
Advanced Card

Black & White To Do Form
Color To Do Form

Primary Button

Primary Button

This primary button is a solid color button with rounded corners. There is a shrink hover effect on this button. Customize the color, text, and onClick function.

import { PrimaryButton } from "atomic10-components";

handleClick  =  ()  =>  {
	alert("Click");
};

<PrimaryButton  value="Click"  onClick={handleClick}  />

Properties

NameTypeDefaultDescription
bkcolorstringNeon CarrotBackground color. Accepts hex, rgb, and string
onClickfunctionnullCallback for buttons onClick
ftcolorstringWhiteFont color. Accepts hex, rgb, and string
valuestringnullText of the button

Styling

List of class names for styling.

NameElement
a10-primary-buttondiv

Secondary Button

Secondary Button

This secondary button is a solid white button with colored border and text. This button has rounded corners. There is a shrink hover effect on this button. Customize the color, text, and onClick function.

import { SecondaryButton } from "atomic10-components";

handleClick  =  ()  =>  {
	alert("Click");
};

<SecondaryButton  value="Click"  onClick={handleClick}  />

Properties

NameTypeDefaultDescription
onClickfunctionnullCallback for buttons onClick
colorstringNeon CarrotBorder and font color. Accepts hex, rgb, and string
valuestringnullText of the button

Styling

List of class names for styling.

NameElement
a10-secondary-buttondiv

Text Input

Text Input

This is a customizable input component. Just like a regular input the type, value, placeholder and more can be specified as properties along with color customization, width, and more features.

import { TextInput } from "atomic10-components";

<TextInput label="Label Input" placeholder="name@example.com" width="30%" />
<hr />
<TextInput label="Password" placeholder="Enter Password" type="password" />

Properties

NameTypeDefaultDescription
typestringtextInput type attribute
labelstringnullLabel above input
valuestringnullInput value attribute
placeholderstringnullInput placeholder value
onChangefunctionnullCallback for onChange
namestringnullName attribute of input
ftColorstringblackInput font color. Accepts hex, rgb, and string
bkColorstringNeon OrangeInput bottom border color. Accepts hex, rgb, and string
widthstringnullInput width. Accepts px, %, and rem/em

Styling

List of class names for styling.

NameElement
a10-simple-form-groupdiv
a10-simple-text-labellabel
a10-simple-text-inputinput

Dropdown

Dropdown

This is a customizable dropdown component. Just like a dropdown the value, onChange, and more can be specified as properties along with color customization and width. The content property is an array of objects to supply the dropdown choices(see example).

import { Dropdown } from "atomic10-components";

<Dropdown
  name='tester'
  value={this.state.value}
  onChange={e => alert(`Changed to ${e.target.value}`)}
  content={content}
/>
<hr />
<Dropdown
  name='tester'
  value={this.state.value}
  onChange={e => alert(`Changed to ${e.target.value}`)}
  content={content}
  ftColor='white'
  bkColor='#FF9933'
/>

Properties

NameTypeDefaultDescription
namestringnullName attribute for select element's value
valuestringnullDropdown value attribute
onChangefunctionnullCallback for onChange
ftColorstringslategrayDropdown font color. Accepts hex, rgb, and string
bkColorstring#eeeDropdown bottom border color. Accepts hex, rgb, and string
widthstringnullDropdown width. Accepts px, %, and rem/em
contentarraynullContent is array of choices formatted as objects

Content-Example:

text and value fields are require. key field is optional.

const content = [
{
   text: 'Item One',
   value: 'one',
   key: 1
 },
 {
   text: 'Item Two',
   value: 'two',
   key: 2
 },
 {
   text: 'Item Three',
   value: 'three',
   key: 3
 }
];

Styling

List of class names for styling.

NameElement
a10-dropdowndiv

Toggle Switch

Toggle Switch

This is a customizable toggle switch. The toggle can be customized with a label, checked/unchecked icons, defaultChecked state, and an onChange function.

To change the primary color from orange:

// CSS
.react-toggle {
  background: blue
}
import { ToggleSwitch } from "atomic10-components";

<ToggleSwitch
  checkIcon='power_off'
  uncheckIcon='power'
  defaultChecked={'default checked state'}
  onChange={'onChange Callback'}
  label='Example Toggle Switch'
/>

Properties

NameTypeDefaultDescription
checkIconstringnullIcon name from Material Design
uncheckIconstringnullIcon name from Material Design
defaultCheckedstate/propnullState/prop for defaultChecked value
onChangefunctionnullCallback for onChange
labelstringnullLabel for toggle

Styling

List of class names for styling.

NameElement
a10-toggle-switch-labellabel
react-toggle-trackdiv(Switch)
react-toggle-thumbdiv(Slider)
material-iconsi(Icon)

Simple Card

Simple Card

This is a simple card that can store data for a product, service, etc. Card can have an onClick added. All content is customizable and the box will auto format as info grows.

import { SimpleCard } from "atomic10-components";

<SimpleCard
  title="Simple Card"
  subTitle="Subtitle"
  paragraph="Simple card that doesn't have an image and a button. This is a paragraph."
  onClick={() => alert("Card Click")}
/>

Properties

NameTypeDefaultDescription
bkColorstringWhiteCard background color. Accepts hex, rgb, and string
brdColorstringBlackBorder color. Accepts hex, rgb, and string
onClickfunctionnullCallback for card onClick
paragraphstringnullParagraph for card
titlestringnullText of the card
subTitlestringnullSubtitle for card
widthstring30%Width for card

Styling

List of class names for styling.

NameElement
a10-secondary-buttondiv
a10-titlediv
a10-subtitlediv
a10-paragraphdiv

Advanced Card

Advanced Card

This is an advanced card that can store data for a product, service, profile, etc. Card and button have separate customizable onClick. Image, content, and button are customizable and the box will auto format as info grows.

import { AdvancedCard } from "atomic10-components";

<AdvancedCard
  title="Simple Card"
  subTitle="Subtitle"
  paragraph="Advanced card that has an image and a button. This is a paragraph."
  onClick={() => alert("Card Click")}
  btnClick={() => alert("Button Click")}
  btnValue="Click"
  image="https://goo.gl/2QuCc5"
  width="50%"
/>

Properties

NameTypeDefaultDescription
bkColorstringWhiteCard background color. Accepts hex, rgb, and string
brdColorstringBlackBorder color. Accepts hex, rgb, and string
btnClickfunctionnullCallback for button onClick
btnColorstringNeon CarrotButton color. Accepts hex, rgb, and string
btnValuestringBlackText of the button
onClickfunctionnullCallback for card onClick
imageimagenullImage for header
paragraphstringnullParagraph for card
titlestringnullText of the card
subTitlestringnullSubtitle for card
widthstring30%Width for card. Accepts px, %, and rem/em

Styling

List of class names for styling.

NameElement
a10-advanced-buttondiv
a10-imgimg
a10-titlediv
a10-subtitlediv
a10-paragraphdiv

Black and White To Do Form

B&W Todo

This is a black and white todo form. Items can be added to the list directly on the component, can be deleted from list, and can be completed(crossed out). The list is persistent through localStorage. You can create a function that clears this storage by removing the key of: "${title} list" from localStorage.

import { BWTodo } from "atomic10-components";

const todoList = ["Fold laundry", "Go to gym", "Wash car", "Walk the dog"];

<BWTodo list={todoList} title="B&W Todo" />

Properties

NameTypeDefaultDescription
titlestringnullTitle of the to do form in header
listarraynullAn array of to do items to prepopulate list

Styling

List of class names for styling.

NameElement
a10-headerdiv
a10-titleh2
myUL(id not class)ul

Colored To Do Form

Color Todo

This is a customizable colored todo form. Items can be added to the list directly on the component, can be deleted from list, and can be completed(crossed out). The list is persistent through localStorage. You can create a function that clears this storage by removing the key of: "${title} list" from localStorage. Colors, title, placeholder, and more can be customized.

import { CTodo } from "atomic10-components";

const todoList = ["Fold laundry", "Go to gym", "Wash car", "Walk the dog"];

<CTodo list={todoList} title="Color Todo" placeholder="New Item..." />

Properties

NameTypeDefaultDescription
titlestringnullTitle of the to do form in header
listarraynullAn array of to do items to prepopulate list
placeholderstringnullPlaceholder for form input
bkColorstringNeon CarrotHeader background color. Accepts hex, rgb, and string
ftColorstringWhiteInput font color. Accepts hex, rgb, and string
inColorstringWhiteInput line color. Accepts hex, rgb, and string
btnColorstringWhiteButton and title color. Accepts hex, rgb, and string

Styling

List of class names for styling.

NameElement
a10-color-tododiv
a10-headerdiv
myUL(id not class)ul

License

MIT License

Issues and Issue Tracker

Please see the open issues in our issue tracker. If you have questions, concerns, bug reports, etc, please file an issue. Our Issue Tracker

Before reporting a bug or issue please make sure it is not already reported. If it isn't, report using the following format.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

A good bug/issue report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

1.2.2

5 years ago

1.2.1

5 years ago

1.1.1

5 years ago

1.1.0

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

0.1.0

5 years ago