@elevate_security/elevate-component-library

Elevate Security Component Library

A component library for sharing Elevate Components between each of our projects

Demo App

---

Installation

npm install @elevate_security/elevate-component-library --save

Usage

cont Elevate =  require('@elevate_security/elevate-component-library')

render() {
  return (
    <Elevate.Typography.H1>This is the tab content 1</Elevate.Typography.H1>
  )
}

Components

• Card
• Icon
• Link
• Typography
• Layout
• Gauge
• LineBarChart
• Axis
• Line
• Input
• Button
• Tabs
• TimelineBlock
• ButtonIcon
• Breadcrumb
• Image
• Avatar
• Header
• GlobalStyle
• Logo

Development

• Clone this repo
• npm install
• To debug or demo in storybook: npm run-script storybook
• To bootstrap work on a new componentnpm: run-script create [component name]

Local Development/importing into other applications

• In component library, run: npm link

• Take the generated link and import into your parent project like so:

const Elevate = require('/usr/local/lib/node_modules/@elevate_security/elevate-component-library')

const { Logo } = Elevate

Deploying to NPM

1. Check out and pull master

git checkout master
git pull

1. Up the version on package.json to next version

    "name": "@elevate_security/elevate-component-library",
    "version": "1.0.6",
    "description": "A library of elevate ui components",

1. Commit, tag with version name and push

TAG=v1.0.6
git add package.json
git commit -m "bumping version to ${TAG}"
git tag ${TAG}
git push origin master ${TAG}