ReloadlyUI

Angular UI library for building rich UI experiences

Please check our demo site and the list of issues to see all the things we are working on. Feel free to make comments there.

Table of Contents

• Demo
• Dependencies
• Installation
• Supported browsers
• Getting help
• Do you think you've found a bug?
• Contributing to the project
• Code of conduct

Demo

Please check all components we have in action at https://ui.reloadly.com

Dependencies

The only dependency is Angular. The supported versions are:

| reloadly-ui | Angular | | ------------ | ------- | | 1.0.2 | 18.0.5 |

Installation

Just run the following:

npm install reloadly-ui

It will install reloadly-ui for the default application specified in your angular.json. If you have multiple projects and you want to target a specific application, you could specify the --project option:

npm install reloadly-ui --project myProject

Development

To run a local version of the library, and link it to your app, first run in the library:

npm run build:dev

Then

npm run build:scss:dev

Then in dist/reloadly-ui run:

npm link

In your Angular project's package.json, use

"dependencies": {
    ...
    "reloadly-ui": "file:../reloadly-ui/dist/reloadly-ui",
    ...
}

In angular.json use "preserveSymlinks": true, and:

"styles": [
    "src/styles.scss",
    "node_modules/reloadly-ui/styles/styles.css"
],

After installing dependencies (npm install), run:

npm link reloadly-ui

or

npm link reloadly-ui --force

This will make Angular automatically rebuild your project when you modify this ui library. You might need to modify and save a component's style sheet file for global style files to be rebuilt.

Supported browsers

We support the same browsers and versions supported by Angular. See Angular browser support for more details.

Our code is automatically tested on all supported browsers.

Getting help

Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. For general support questions you can try StackOverflow and tag the question with the reloadly-ui tag.

Do you think you've found a bug?

We want to fix it ASAP! But before fixing a bug we need to reproduce and confirm it.

We ask you to respect two things:

• fill the GitHub issue template by providing the bug description and appropriate versions of Angular, reloadly-ui and TypeScript
• provide a use-case that fails with a minimal reproduction scenario using StackBlitz

A minimal reproduction scenario allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

Interestingly, from our experience users often find coding problems themselves while preparing a minimal StackBlitz. We understand that sometimes it might be hard to extract essential bits of code from a larger code-base but we really need to isolate the problem before we can fix it.

Contributing to the project

Please check DEVELOPER.md for documentation on running the project locally and CONTRIBUTING.md for contribution guidelines.

Code of conduct

Please take a moment and read our Code of Conduct