1.17.8 • Published 3 years ago

@readme/ui v1.17.8

Weekly downloads
1,199
License
ISC
Repository
github
Last release
3 years ago

ReadMe UI

npm install -S @readme/ui

Workflow

Run these commands to develop and document UI components locally:

npm start     # start the local Styleguidist dev server
npm test      # run tests against the UI library
npm run watch # watch and rebuild, for local linked dev

Creating New Components

Use the elem command to quickly scaffold out a new component or composition:

npm run elem -- MyUIElement "composition" # or "component" by default

This generates the JSX file, stylesheet, tests, and markdown docs for your new element all in one go.

Architecture

src/
│ ui/             # UI component library:
│ ├ components/   # - lower-level UI building blocks
│ └ compositions/ # - higher-order UI constructs
└ styles/         # SCSS vars, mixins; CSS resets; etc.

Under the Hood

This repository brings together a number of utilities and tools for various front end development workflows:

Dependencies 
React & Sassfor components and styling
Styleguidistto power our living documentation
Babel & Webpack/NWBfor transpiling and compilation
Lodashfor various Javascript utility methods
ui-librarycomponent-libraryliving-styleguidereact
@bem-react/classname@readme/emojis@readme/oas-to-snippet@readme/syntax-highlighter@readme/variablealgoliasearchclipboard-copyemoji-regexjs-cookielodashmodularscale-sassreact-instantsearch-dom
@infinitebrahmanuniverse/nolb-_read@everything-registry/sub-chunk-768@zalastax/nolb-_read
1.17.8

3 years ago

1.17.8-next.1

3 years ago

1.17.7

3 years ago

1.17.7-next.1

3 years ago

1.17.6

3 years ago

1.17.6-next.2

3 years ago

1.17.6-next.1

3 years ago

1.17.4-next.1

3 years ago

1.17.4-next.2

3 years ago

1.17.5

3 years ago

1.17.4

3 years ago

1.17.3

3 years ago

1.17.3-next.1

3 years ago

1.17.2

3 years ago

1.17.1-next.5

3 years ago

1.17.1

3 years ago

1.17.1-next.4

3 years ago

1.17.1-next.3

3 years ago

1.17.1-next.2

3 years ago

1.17.0-next.4

3 years ago

1.17.1-next.1

3 years ago

1.17.0

3 years ago

1.17.0-next.3

3 years ago

1.17.0-next.2

3 years ago

1.17.0-next.1

3 years ago

1.16.1-next.1

3 years ago

1.16.1

3 years ago

1.16.0

3 years ago

1.16.0-next.1

3 years ago

1.15.1-next.1

3 years ago

1.15.1

3 years ago

1.15.0-next.1

3 years ago

1.15.0

3 years ago

1.14.2

3 years ago

1.14.2-next.5

3 years ago

1.14.2-next.4

3 years ago

1.14.2-next.3

3 years ago

1.14.2-next.2

3 years ago

1.14.2-next.1

3 years ago

1.14.1

3 years ago

1.14.1-next.2

3 years ago

1.14.1-next.3

3 years ago

1.14.1-next.4

3 years ago

1.14.0

3 years ago

1.14.1-next.1

3 years ago

1.14.0-next.3

3 years ago

1.14.0-next.2

3 years ago

1.14.0-next.1

3 years ago

1.13.0-next.2

3 years ago

1.13.0

3 years ago

1.13.0-next.1

4 years ago

1.12.0-next.2

4 years ago

1.12.0

4 years ago

1.11.1-next.2

4 years ago

1.12.0-next.1

4 years ago

1.11.1-next.1

4 years ago

1.11.0-next.2

4 years ago

1.11.0-next.1

4 years ago

1.11.0

4 years ago

1.10.3

4 years ago

1.10.3-next.3

4 years ago

1.10.3-next.2

4 years ago

1.10.3-next.1

4 years ago

1.10.2

4 years ago

1.10.2-next.1

4 years ago

1.10.1

4 years ago

1.10.1-next.1

4 years ago

1.10.0

4 years ago

1.10.0-next.6

4 years ago

1.10.0-next.5

4 years ago

1.10.0-next.4

4 years ago

1.10.0-next.3

4 years ago

1.10.0-next.2

4 years ago

1.10.0-next.1

4 years ago

1.9.4-next.1

4 years ago

1.9.3

4 years ago

1.9.3-next.1

4 years ago

1.9.1

4 years ago

1.9.2

4 years ago

1.9.0-next.2

4 years ago

1.9.0-next.1

4 years ago

1.9.0

4 years ago

1.8.3-next.1

4 years ago

1.8.2

4 years ago

1.8.2-next.4

4 years ago

1.8.2-next.3

4 years ago

1.8.2-next.2

4 years ago

1.8.2-next.1

4 years ago

1.8.1

4 years ago

1.8.1-next.2

4 years ago

1.8.1-next.1

4 years ago

1.8.0

4 years ago

1.8.0-next.2

4 years ago

1.8.0-next.1

4 years ago

1.7.4

4 years ago

1.7.4-next.1

4 years ago

1.7.3-next.2

4 years ago

1.7.3

4 years ago

1.7.3-next.1

4 years ago

1.7.2-next.1

4 years ago

1.7.2-next.2

4 years ago

1.7.2

4 years ago

1.7.1-next.3

4 years ago

1.7.1

4 years ago

1.7.1-next.2

4 years ago

1.7.1-next.1

4 years ago

1.7.0-next.2

4 years ago

1.7.0

4 years ago

1.7.0-next.1

4 years ago

1.6.1

4 years ago

1.6.1-next.1

4 years ago

1.6.0

4 years ago

1.6.0-next.3

4 years ago

1.6.0-next.2

4 years ago

1.6.0-next.1

4 years ago

1.5.0

4 years ago

1.5.0-next.3

4 years ago

1.5.0-next.2

4 years ago

1.5.0-next.1

4 years ago

1.4.5

4 years ago

1.4.5-next.1

4 years ago

1.4.4

4 years ago

1.4.4-next.3

4 years ago

1.4.4-next.2

4 years ago

1.4.4-next.1

4 years ago

1.4.3

4 years ago

1.4.3-next.1

4 years ago

1.4.2

4 years ago

1.4.2-next.1

4 years ago

1.5.0-beta.1

4 years ago

1.4.1

4 years ago

1.4.1-next.3

4 years ago

1.4.1-next.2

4 years ago

1.4.1-next.1

4 years ago

1.4.0

4 years ago

1.4.0-next.17

4 years ago

1.4.0-next.15

4 years ago

1.4.0-next.16

4 years ago

1.4.0-next.12

4 years ago

1.4.0-next.13

4 years ago

1.4.0-next.14

4 years ago

1.4.0-next.11

4 years ago

1.4.0-next.10

4 years ago

1.4.0-next.9

4 years ago

1.4.0-next.8

4 years ago

1.4.0-next.7

4 years ago

1.4.0-next.6

4 years ago

1.4.0-next.5

4 years ago

1.4.0-next.3

4 years ago

1.4.0-next.4

4 years ago

1.4.0-next.1

4 years ago

1.4.0-next.2

4 years ago

1.3.3-next.2

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.2.2-next.1

4 years ago

1.2.0

4 years ago

1.2.1

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.0

4 years ago

0.15.1

4 years ago

0.15.0

4 years ago

0.14.4

4 years ago

0.14.3

4 years ago

0.14.2

4 years ago

0.14.1

4 years ago

0.14.0

4 years ago

0.13.3

4 years ago

0.13.1

4 years ago

0.13.2

4 years ago

0.13.0

4 years ago

0.12.0

4 years ago

0.11.0

4 years ago

0.10.8

4 years ago

0.10.7

4 years ago

0.10.6

4 years ago

0.10.4

4 years ago

0.10.5

4 years ago

0.10.3

4 years ago

0.10.2

4 years ago

0.10.1

4 years ago

0.10.0

4 years ago

0.9.5

4 years ago

0.9.4

4 years ago

0.9.3

4 years ago

0.9.2

4 years ago

0.9.1

4 years ago

0.9.0

4 years ago

0.8.7

4 years ago

0.8.6

4 years ago

0.8.5

4 years ago

0.8.4

4 years ago

0.8.3

4 years ago

0.8.2

4 years ago

0.8.1

4 years ago

0.8.0

4 years ago

0.7.25

4 years ago

0.7.24

4 years ago

0.7.22

4 years ago

0.7.23

4 years ago

0.7.21

4 years ago

0.7.20

4 years ago

0.7.19

4 years ago

0.7.18

4 years ago

0.7.17

4 years ago

0.7.11

4 years ago

0.7.13

4 years ago

0.7.12

4 years ago

0.7.15

4 years ago

0.7.14

4 years ago

0.7.16

4 years ago

0.7.10

4 years ago

0.7.9

4 years ago

0.7.8

4 years ago

0.7.7

4 years ago

0.7.6

4 years ago

0.7.5

4 years ago

0.7.4

4 years ago

0.7.3

4 years ago