Looker UI Components
This package provides a series of components that implement Looker's Design System.
To get started add the Looker Components NPM package:
npm install @looker/components
yarn add @looker/components
You'll also need to satisfy
@looker/components peer dependencies - Lodash, React, & Styled Components:
npm install lodash react react-dom styled-components
yarn add lodash react react-dom styled-components
Finally, if you're using Typescript you'll want to add the associated types for the dependencies (note @looker/components is built in Typescript and therefore has built-in types).
npm install --dev @types/lodash @types/react @types/react-dom @types/styled-components
yarn add --dev @types/lodash @types/react @types/react-dom @types/styled-components
Watching Build Changes
Working on the components package? This package includes a
develop script to make is easy to watch the code for changes and have it automatically recompiled.
yarn workspace @looker/components develop builds the component library with a
--watchflag. Useful when actively developing a component and you wish to see the changes appear in either the style guide or react playground
Documenting Components in WWW
To begin documenting a new component, you must first import it into allComponents.ts, and attach it the