Skip to the content

Documentation

The command

list, info, add, theme and doctor.

rivier-ui is the library's own command. It runs from a copy of the library, as npm run ui --, and works on the project named with dir=. The library's repository opens at launch; until then, Installation has the ways that work from this site.

What it does

rivier-ui list [words]            # what there is, or a search
rivier-ui info <name>             # what an item is, when to use it, an example
rivier-ui add <name>... | all     # copy items, what they need, and the theme into the project
rivier-ui theme                   # copy (or refresh) only the theme
rivier-ui doctor                  # check a project

Its words

Options are plain words, not flags.

  • dir=<project>: the project to work on.
  • overwrite: replace files that are already there, your own edits to them included.
  • dry: say what would be done, and do nothing.

What add does

  • Copies each item, and every item it imports, into src/components/<group>/ and src/lib/, with its header comment.
  • Puts the theme in src/styles/rivier-ui.css and imports it after Tailwind in the global stylesheet.
  • Installs the packages the items import, at their latest release, and the type packages of those that keep their types apart.
  • Leaves alone any file you have changed, unless you say overwrite.

What doctor checks

That the theme is there, current and imported; that the packages the copied items need are installed; and which copied files differ from the library's.