Foris JS library is a set of components and utils for reForis and plugins.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Bogdan Bodnar a7dcced08b
Add weblate config file.
4 years ago
docs Core review docs fixes. 5 years ago
scripts Wi-Fi settings form 4 years ago
src Added date and time utilities. 4 years ago
translations Display actual error within the form. 4 years ago
.eslintignore Extract the library from reforis. 5 years ago
.eslintrc.js Shared lint configs 5 years ago
.gitignore Added virtual environment and packages required for translations. 5 years ago
.gitlab-ci.yml Flat structure of published package 5 years ago
.weblate Add weblate config file. 4 years ago
Makefile Wi-Fi settings form 4 years ago
README.md Add warning about using <ForisForm /> component in plugins. 4 years ago
babel.cfg Updated translation messages after moving WiFi form. 4 years ago
babel.config.js Fix for exposed libraries. 4 years ago
jest.config.js Moved moment-timezone to devDependencies. 4 years ago
package-lock.json Added date and time utilities. 4 years ago
package.json Added date and time utilities. 4 years ago
requirements.txt Added virtual environment and packages required for translations. 5 years ago
styleguide.config.js Download docs css via NPM. 5 years ago

README.md

foris-js

Set of utils and common React elements for reForis.

Publishing package

Beta versions

Each commit to dev branch will result in publishing a new version of library tagged beta. Versions names are based on commit SHA, e.g. foris@0.1.0-beta.d9073aa4.

Preparing a release

  1. Crete a merge request to dev branch with version bumped
  2. When merging add [skip ci] to commit message to prevent publishing unnecessary version
  3. Create a merge request from dev to master branch
  4. New version should be published automatically

Manually managed dependencies

Because of <ForisForm /> component it's required to use exposed ReactRouterDOM object from react-router-dom library. ReactRouterDOM is exposed by reForis. It can be done by following steps:

  1. Setting react-router-dom as peerDependencies and devDependencies in package.json.
  2. Adding the following rules to externals in webpack.conf.js of the plugin:
externals: {
    ...
    "react-router-dom": "ReactRouterDOM",
}