Skip to content
Faithlife UI styleguide and set of components
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Feb 27, 2019
catalog Merge pull request #157 from RobertBolender/accordion-component May 21, 2019
components Hopefully fix tests failing during build. May 22, 2019
tests Fix server-render in group selector (#103) Jan 15, 2019
.babelrc Update browserslist config to exclude opera mini. Feb 19, 2019
.editorconfig Add storybook and lint config Apr 9, 2018
.eslintignore Avoid eslint hang when linting built catalog files Nov 16, 2018
.eslintrc Add files section component. (#29) Sep 12, 2018
.gitattributes Add storybook and lint config Apr 9, 2018
.gitignore Switch to yarn to avoid package restore crashes Jul 13, 2018
.npmrc
.prettierrc Add storybook and lint config Apr 9, 2018
.stylelintrc
.travis.yml Switch to yarn to avoid package restore crashes Jul 13, 2018
README.md Add publish steps Aug 21, 2018
VersionHistory.md v5.7.1 May 22, 2019
index.js Update module packing logic Apr 12, 2018
package.json
postcss.config.js Add storybook and lint config Apr 9, 2018
webpack.config.js
yarn.lock

README.md

Styled UI

Build Status code style: prettier style: styled-components

View Demos Here

How to contribute

  • File an issue first describing what you'd like to change, or check with one of the maintainers before doing any work to ensure you are headed in the right direction
  • Clone this repository locally.
  • Install NodeJS
  • Install Yarn
  • From a terminal, run these commands from the project directory
    • yarn to restore packages
    • yarn build to build webpack
    • yarn catalog-start to start the development environment
    • yarn precommit to fix style errors before committing
  • When you're ready to commit your work, create a new branch for your contribution, and then sync your branch with Github
  • Open a pull request via the Github Web UI to request review

How to publish

Why?

This project addresses problems introduced by creating components from scratch. Often a component from spec gets implemented multiple times, either from Zeplin or forked from an existing control. Each time an implementation happens, inconsistencies are introduced. It's also harder to introduce animations and shadows after the prototype has been built. By using reference components instead, there's a much higher chance the final products will the contain all margins, animations, and hover states the design calls for.

Goals

  • Components in this library must be built with Styled Components + React. Large additional runtime libraries should not be added such as moment, but tiny dependencies like lodash.debounce are OK.
  • UI components should support basic color theming and should have a variation documented that demos an alternate theme.
  • UI components are simple. For complex components (such as a sortable list control with inline search), consider creating a reusable component in a separate project
  • Style modifications should be approved by the design team before they are merged into this project
  • Components should have a prose description and live demo of different component states (using real data)
  • UI components are accompanied by documentation to show how the component should be used within a real app. The UI components should rely on a parent component to contain state, however in some cases local state may be used to handle UI-specific concerns (such the location of a popup or visibility)
  • Semantic versioning / version history updates when making releases
  • Third-party components, such as ag-grid or bootstrap, will have their stylesheet re-exported with the Faithlife styles applied (preferably via sass variables and no styles that require an opinionated CSS reset)
    • Customizations should be done via sass variables if possible, instead of hacky css overrides
    • If an opinionated CSS reset is required, the CSS reset styles should be scoped to a div that this library controls (for example, look at how bootstrap is imported). This is required so that other styles on the page won't break when styled-ui is imported.
You can’t perform that action at this time.