Randall Moreyanddvonanderson
54c5c7fdc5
* fix: 🐛 refactor info-field component Overall context of how the `<InfoField/>` was changed to the correct order. Corrected css grid to have the order of `label,input-field,helper-text`. Also refactored all component instances affected by the change. * refactor: 💡 refactor styling for icon to be center refactor will get the icon as close to center as possible. * chore: 🤖 ssh type first; update names and descriptions * chore: 🤖 tweak info field styles * chore: 🤖 fix formatting/linting issue * refactor: 💡 credential stylistic changes per PR feedback * chore: 🤖 reuse configPath * fix: 🐛 fix lint error * chore: 🤖 add target type field helper text Co-authored-by: dvonanderson <devon.anderson@hashicorp.com>
Rose - Style & Component Ember Addon for Boundary
This addon contains common styles and components shared by Boundary UIs.
Table of Contents generated with DocToc
- Add Styles to an App
- Installation
- Yarn Commands
- Linting
- Formatting
- Building Components
- Using Components
- Running tests
- Running the dummy application
- Contributing
Add Styles to an App
Add this addon to an Ember application's devDependencies as:
"rose": "*", for applications included in this monorepo. Application's
may then import rose styles by adding @import 'rose'; to their stylesheets.
Installation
See monorepo README for installation instructions.
Yarn Commands
List of available project commands. yarn run <command-name>
| Command | Description |
|---|---|
| build:development | Builds the dummy app in development mode. |
| build | Builds the dummy app for production. |
| lint | Runs all lint commands. |
| lint:fix | Runs automatic lint fixes for all files. |
| lint:hbs | Lints template hbs files. |
| lint:hbs:fix | Runs automatic lint fixes for hbs files. |
| lint:js | Lints js files. |
| lint:js:fix | Runs automatic lint fixes for js files. |
| lint:sass | Lints scss files. |
| format | Runs all auto-formatters. |
| format:js | Auto-formats js files using Prettier. |
| format:hbs | Auto-formats hbs files using Prettier. |
| format:sass | Auto-formats scss files using Prettier. |
| start | Runs the dummy app local server. |
| storybook | Runs the Storybook local server on port 6006. Be sure to start the standard server (see above) in a separate terminal. |
| test | Runs all tests. |
| test:ember-compatibility | Runs tests across multiple Ember versions with ember-try. |
| precommit | Runs all lint, format and tests. |
| doc:toc | Automatically generates a table of contents for this README file. |
Additional commands in the monorepo package may affect this projects.
Linting
yarn lint:hbsyarn lint:jsyarn lint:js --fix
Formatting
Before submitting your work, be sure to run auto-formatters (see commands above). This helps to ensure consistency among authors.
yarn format
Building Components
To build a new component, start by generating it on the command line with
ember g component rose/component-name. Then manually add a Storybook story in
component-name.stories.mdx. Use the Storybook UI during component
development (see Yarn commands).
Using Components
A few of the components have additional ember package dependencies that need to be installed before usage.
| Component | Dependency |
|---|---|
| Rose::Dropdown | ember-modifier |
Running tests
yarn test– Runs the test suite on the current Ember versionyarn test --server– Runs the test suite in "watch mode"yarn test:all– Runs the test suite against multiple Ember versions
Running the dummy application
yarn start- Visit the dummy application at http://localhost:4200.
Contributing
See monorepo README for more contribution instructions.
Building ToC
To autogenerate a ToC (table of contents) for this README,
run yarn doc:toc. Please update the ToC whenever editing the structure
of README.