venusangandZhihe Li
c8737f0474
A new param @ariaDescription that was added to addons/rose edit-toggle component which now allows us to define the value of aria-description per a11y requirements. With this change, the User detail edit form button now includes a value for aria-description. ✅ Closes: FE-112 --------- Co-authored-by: Zhihe Li <zhihe.li@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
- Pnpm 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": "workspace:*", for applications included in this monorepo. Application's
may then import rose styles by adding @use 'rose'; to their stylesheets.
Installation
See monorepo README for installation instructions.
Pnpm Commands
List of available project commands. pnpm 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. |
| 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
pnpm lint:hbspnpm lint:jspnpm lint:js --fix
Formatting
Before submitting your work, be sure to run auto-formatters (see commands above). This helps to ensure consistency among authors.
pnpm format
Building Components
To build a new component, start by generating it on the command line with
ember g component rose/component-name.
Running tests
pnpm test– Runs the test suite on the current Ember versionpnpm test --server– Runs the test suite in "watch mode"pnpm test:all– Runs the test suite against multiple Ember versions
Running the dummy application
pnpm 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 pnpm doc:toc. Please update the ToC whenever editing the structure
of README.