Elements
Elements is the React based UI library for the Weekday platform. This is library should be considered as pre alpha right now - active development is continuing. See below roadmap for progress.
Installation
npm i --save @weekday/elements
yarn add @weekday/elements
Global packages
- Node v9.x
- Webpack 4.x
- Npm v4.2.0
Building & installation
All of the building happens with npm or Yarn
Testing & linting
npm run test
npm run lint
Dev server
npm run storybook
npm run dev
Building
npm run build
npm run build:prod
npm run build:storybook
Roadmap (not in any particular order)
- Project setup
- Repo & GitHub pages setup
- Preliminary components & tests (avatar & button)
- Continuous deployment runner for tests & Storybook generating
- NPM package
- Attachment component
- Avatar component
- Button component
- Error component
- Input component
- Loading component
- Members component
- Menu component
- Modal component
- Notification component
- Popup component
- Channel component
- Spinner component
- Tabbed component
- Textarea component
- Tooltip component
- Toggle component
- User component
- Select component
- Progress component
- Code coverage (add badge)
- More robust component tests
- More component stories
- Mobile responsive styles
- Website
- Better docs/comments