1.0.0 • Published 5 years ago

jeanelle-chek v1.0.0

Weekly downloads
3
License
-
Repository
-
Last release
5 years ago

Get Started

The following are required to use the library:

  • Node.js
  • Storybook
    • Get started using the automated command line tool. This command automatically setups storybook.
    npx -p @storybook/cli sb init --type react
    • Run storybook
    npm run storybook
  • Visual Code

Components included:

Components

Buttons

Buttons are touchable components that users can use to interact with the screen. Buttons can be styled according to needs to look a specific way.

Floating Action Buttons

FloatingButtons

Usage
import FloatingButton from '../src/components/floating-button/floating-button';

<FloatingButton
     style=""
     color="blue"
     textColor="white"
     position="left"
     icon="plus"
     title="Add location" />
 
Props

Contained Buttons

ContainedButtons

Usage
import ContainedButton from '../src/components/contained-button/contained-button'

<ContainedButton
     style=""
     title="Save"
     deactivated={true} />)
 
Props

References

Style

ValueDescription
-External style defined

Color

ValueDescription
BlueRender a component with blue background
WhiteRender a component with White background

textColor

ValueDescription
BlueRender a component with blue text
WhiteRender a component with white text

Position

ValueDescription
LeftRender a component positioned on the left
RightRender a component positioned on the right

Icon

ValueDescription
plusRender a component with a plus icon
locationRender a component with a location icon

Title

ValueDescription
-Text to be displayed on the component

Deactivated

ValueDescription
trueRender a deactivated component that is not clickable
falseRender a component that is clickable