Ember HK ComponentsReusable Ember components
AssumptionsUsage of these components assumes you are using the Purple3 CSS framework and Malibu.
ember-cli-eyeglassif it's not installed already.
ember install --save ember-cli-eyeglass
ember install --save @heroku/ember-hk-components
CSSYou'll need to import the scss files that support the actual components into your app. Ensure that you have installed
ember-cli-eyeglassand that you are using
app.scssfor your app's styles.
You can import css for all the components like this:
If you want to import the css for only a specific component, like
hk-slide-panel, you can include it like this:
ComponentsSee ember-hk-components.herokuapp.com for a complete list of components that are available.
git clone https://github.com/heroku/ember-hk-components
- Visit your app at http://localhost:4200.
ember try:eachto test your addon against multiple Ember versions)
ember test --server
Local Usage in Another ApplicationThe demo app is useful for developing this addon, but it can often be helpful to consume your version of this addon in another application either to more easily develop your changes or to validate that your changes work as you expect. You can use your local version of
ember-hk-componentsin another application that consumes it via yarn's link command.
// in your ember-hk-components directory > yarn link // in your consuming app directory > yarn link @heroku/ember-hk-components // to put consuming app back on the release version > yarn unlink @heroku/ember-hk-components
Now, when you make changes in your copy of
ember-hk-componentsthose changes will be reflected in the consuming application.
NotesThis library does its best to follow the principles of Semantic Versioning. Every effort should be made to ensure all non-major versions are released in a backwards compatible way.
ChangelogThis project's changelog is generated using
lerna-changelog. You can find instructions on how to setup your local environment for this in the project's Readme. Note that the Personal access token you use must be SSO-enabled for this to work.
lerna-changelogworks off a system of labels defined in this project's package.json. Pull requests will be collated into the changelog based on which label has been applied to them.
Making a New ReleaseOnce you are ready to make a new release follow these steps:
- Ensure all merged pull requests are labelled correctly as indicated in the Changelog section
- Create a new branch
- Update the version number in
yarn run changelog --from x.x.xwhere
x.x.xis the last version of this library that was released. This should generate changelog of changes since that last release.
- Copy the output of that command into Changelog.md
- Commit your changes and open a PR
Once the PR is approved and merged you can then tag your new version by running
git tag x.x.xwhere
x.x.xis the new version number. Push your tag to GitHub using
git push origin --tags.
Publish your new version to npm with the command
Note that you must have publish access to the @heroku npm organization to successfully publish