rfsg-ember-components

This ember addon provides common functionality for any Rightfind Suite app that is built using Ember framework.

Compatibility

• Ember.js v4.4 or above
• Ember CLI v4.4 or above
• Node.js v20.18.2 or above

Installation

ember install rfsg-ember-components

Tailwind

• Tailwind configuration

App & Instance initializers

• Global Config Initializer & Instance Initializer

Components

Layout

• Rightfind Suite Header
• Rightfind Suite Footer
• Rightfind Suite Left Panel
• Rightfind Suite Tab

Libraries

• Rightfind Suite Tag Modal

Orders

• Rightfind Suite Add to Cart Button
• Rightfind Suite Request Item Button
• Rightfind Suite Shopping Cart
• Rightfind Suite ACL Coverage Badge
• Rightfind Suite Open Access Badge
• Rightfind Suite View PDF Button

Search

• Rightfind Suite Searchbar
• Rightfind Suite Scope Selector
• Rightfind Suite View In Data Source Button

Views

• Rightfind Suite Citation Block
• Rightfind Suite Tab Fixed Details
• Rightfind Suite Views Common Template

Services

• @service ('rfsuite-event-service')

Modifiers

• (modifier 'click-outside' this.onClickOutsideAction)

Helpers

• sanitize-html

Internationalization (i18n)

• Translations maintenance

How to test your addon prior to release it

1. Using npm link

In the addon root folder execute the following command

npm link

It will link the addon using the name provided in the package.json

2. Go to the application where you want to test your addon and execute the following command

npm link <addon name>

eg.
npm link rfsg-ember-components

3. Run your Ember App.

Note: If you get the following error "Typechecking failed". Go to the tsconfig.json file and set the "notEmitOnError" property to false.

{
  ...
  "noEmitOnError": false,
  ...
}

Your application should work despite all the typescript errors in the console.

Security

We have created the following section with the aim to detect and apply some security rules around our UI in order to prevent some security issues.

API Mocking

In order to improve the DX and speed up the FE development on those situation where the BE endpoints are not ready yet we have decided to use the Mock Service Worker which is an API mocking library that uses Service Workers to manage the network events.

See the following section to get more information about how to apply and use it on your app.

Conventions

• How to manage versioning

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.