1
0
mirror of https://gitlab.nic.cz/turris/reforis/foris-js.git synced 2025-06-16 13:46:16 +02:00

Compare commits

..

2 Commits

Author SHA1 Message Date
e6098b19dc Bump v5.0.2 2020-09-22 20:41:37 +02:00
661f92bbcf Fix infinity loop caused by WebSockets 2020-09-14 06:38:23 +02:00
148 changed files with 23304 additions and 42555 deletions

View File

@ -1,3 +1,6 @@
module.exports = { module.exports = {
extends: "eslint-config-reforis", extends: "eslint-config-reforis",
rules: {
"import/prefer-default-export": "off",
},
}; };

View File

@ -1,4 +1,4 @@
image: registry.nic.cz/turris/reforis/reforis/reforis-image image: node:8-alpine
stages: stages:
- test - test
@ -6,7 +6,7 @@ stages:
- publish - publish
before_script: before_script:
- apt-get update && apt-get install -y make - apk add make
- npm install - npm install
test: test:

View File

@ -1,416 +0,0 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [6.1.0] - 2024-08-23
### Added
- Added & updated Weblate translations
### Changed
- Migrated to Font Awesome v6
- NPM audit fix
## [6.0.3] - 2024-07-26
### Changed
- Updated WiFiQRCode component
## [6.0.2] - 2024-06-28
### Added
- Added className prop to CheckBox and Radio components
## [6.0.1] - 2024-06-26
### Added
- Added className prop to Switch component
### Changed
- Updated dependencies in package.json
- NPM audit fix
## [6.0.0] - 2024-06-11
### Added
- Added CHANGELOG.md
- Added JS_DIR variable to Makefile
- Added support for shared reForis ESLint configuration
### Changed
- Updated dependencies in package.json
- Updated Spinner.css styles for better positioning and responsiveness
- Migrated to Bootstrap 5
- NPM audit fix
- Other small improvements
## [5.6.1] - 2024-01-19
- Added & updated Weblate translations
- Fixed loading state & button's layout
- Updated bootstrap library to version 4.6.2
- Used custom reforis-image in GitLab CI/CD
- NPM audit fix
## [5.6.0] - 2022-12-29
- Add & update Weblate translations
- Add CustomizationContext and custom hook
- Update caniuse-lite
- Remove testUtils from .gitignore
- Make ieee80211w_disabled as optional in WiFiForm
- Move contexts in a context folder
- NPM audit fix
## [5.5.0] - 2022-12-02
- Add & update translations
- Add a switch to disable Management Frame Protection (802.11w)
- Improved Foris JS documentation
- NPM audit fix
## [5.4.1] - 2022-06-03
- Add Weblate translations
- Update PropType peer dependency
- NPM audit fix
## [5.4.0] - 2022-05-20
- Add & update translations
- Add CopyInput bootstrap component
- Update WiFiForm labels and description for wifi ax
- Make WS path in lighttpd mode configurable
- Fix Wi-Fi password helptext string
- NPM audit fix
## [5.3.0] - 2022-02-21
- Added & update translations
- Added rest of the props to DownloadButton component
- Added hostname validation
- Added wifi 802.11ax HE modes
- Set best Wi-Fi HT mode depending on the checked frequency
- Improved domain name RegEx pattern
- Removed customOrder prop in Select component
- Fixed Wi-Fi translation strings
- Fixed autocomplete attribute in PasswordInput
- Fixed WiFi password max length check
- Fixed documentation build
- Fixed access token in publish script
- Refined & restructure Makefile
- Updated GitLab CI image to Node.js v16
- NPM update (several dependencies)
- NPM audit fix
## [5.2.0] - 2021-12-15
- Remove login page
- NPM audit fix
## [5.1.16] - 2021-11-18
- Revert bad NPM audit fix
- NPM audit fix
## [5.1.15] - 2021-11-03
- Add WPA3 option
- Add custom order ability of Select options
- NPM audit fix
## [5.1.14] - 2021-07-30
- Add & update translations
- Fix infinity redirect loop when WS error occurs
- NPM audit fix
## [5.1.13] - 2021-06-30
- Add sentinelAgreement endpoint to forisUrls
- NPM audit fix
## [5.1.12] - 2021-05-14
- Add & update translations
- Add & fix obsolete links
- Expend library with the ResetWifiSettings function
- Fix switching Wi-Fi modes depending on bands in WiFiForm
- Fix translation sources in WiFiForm
- NPM audit fix
- Other small improvements
## [5.1.11] - 2021-01-04
- Remove duplicated file for Norwegian language
- Fix translations inconsistency
## [5.1.10] - 2021-12-29
- Add and update translations
## [5.1.9] - 2021-12-20
- Increase bottom margin of formFieldsSize
- Change formFieldsSize of ResetWiFiSettings card
- Fix trailing space in Modal classes
## [5.1.8] - 2020-12-19
- Add isPluginInstalled function
## [5.1.7] - 2020-11-27
## [5.1.6] - 2020-11-25
- NPM audit fix
- Add displayCard function to utils
- Add optional sizes to Modal
- Add information about optional sizes to docs
- Remove redundant merge.py
## [5.1.5] - 2020-09-25
- Fix DateTime import
- Fix extra empty space in Switch's classes
## [5.1.4] - 2020-09-25
- Add inline option to Wi-Fi's RadioSet
- Fix Alert's dismissible class condition
- Add closing bootstrap modal using ESC
- Change reboot modal's heading to "Warning!"
## [5.1.3] - 2020-09-11
- Add SSID validation for 32 bytes length
- Add helpText for SSID input
## [5.1.2] - 2020-09-08
- Fix infinity loop caused by WebSockets
- Resolve small issues
## [5.1.1] - 2020-08-31
- Add "inline" option to RadioSet
- NPM audit fix
## [5.1.0] - 2020-08-25
- Add new Switch component
- Swap checkboxes for switches on Wi-Fi page
- Decrease button width on different breakpoints
- Add integration of Prettier + ESLint + reForis Style Guide
- Add appropriate links to dropdown headers
- Add semantic & accessibility structure for headings
- NPM audit & Update packages
- GitLab CI: image update to node 10
## [5.0.3] - 2020-09-23
- Fixes issue with WebSockets
## [5.0.2] - 2020-09-22
- Fix infinity loop caused by WebSockets
## [5.0.1] - 2020-07-21
- Fix Wi-Fi Form
- NPM audit fix & update of packages
## [5.0.0] - 2020-05-07
- I've realized that it should be major update due to broken API.
## [4.5.1] - 2020-05-07
- Add initialData to ForisForm children.
- Update translations .pot file.
## [4.5.0] - 2020-03-25
- Use exposed pdfmake.
- NPM audit fix & update of packages.
## [4.4.0] - 2020-03-13
- Update domain validation.
## [4.3.1] - 2020-03-06
- Add logout link.
## [4.3.0] - 2020-02-26
- Allow RadioSet accept elements as children.
- Add option to make modal scrollable.
## [4.2.0] - 2020-02-21
- Add translations.
- Improve datatime localization.
## [4.1.0] - 2020-02-20
- Added date and time utilities.
## [4.0.0] - 2020-02-20
- Throw an error if unhandled exception happens during API request.
## [3.4.0] - 2020-02-17
- Display actual GET error response within the form.
- Added styles extracted from reForis.
- Added reference to form element (for programmatically submitting it).
## [3.2.0] - 2020-01-17
- Swapped react-router with react-router-dom. Prepared Foris JS for using
react-router-dom exposed by reForis.
- Added controller ID filter to WebSocket hook.
- Updated translation messages after moving WiFi form.
- Increased request timeout to 30.5 sec.
## [3.1.1] - 2020-01-10
- Fixed package dependencies related to exposing libraries via reForis
## [3.1.0] - 2020-01-09
- Added Wi-Fi settings form
- Fixed path to index.js file in package.json
## [3.0.0] - 2020-01-07
- Removal of Babel compiler
- Fixed width of ForisForm, removed default sizing for form widgets (like
buttons)
## [2.1.1] - 2020-01-06
- Display date and time picker above input element
## [2.1.0] - 2019-12-19
- Set WebSocket logging to debug level
- Added hook that detects clicking outside of component
- Added Radio to list of publicly available components
- Fixed link to git repository in package.json
## [2.0.0] - 2019-12-09
- Added dynamic suffix for API URLs (allowing to use one hook for different
resources with e.g. PUT)
- Added unsubscribe method to WebSocket client
- Added custom class to SpinnerElement
- Improved documentation
- Published README.md
## [1.4.0] - 2019-11-29
- Add reboot button.
- Fix Foris URLs prefixes
## [1.3.3] - 2019-11-22
- Add translations from Weblate.
## [1.3.2] - 2019-11-20
- Expose only AlertContext.
- Add hook for API pooling.
## [1.3.1] - 2019-11-14
## [1.2.0] - 2019-10-24
## [1.1.0] - 2019-10-22
## [1.0.0] - 2019-10-07
## [0.0.7] - 2019-09-02
[unreleased]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v6.1.0...master
[6.1.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v6.0.3...v6.1.0
[6.0.3]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v6.0.2...v6.0.3
[6.0.2]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v6.0.1...v6.0.2
[6.0.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v6.0.0...v6.0.1
[6.0.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.6.1...v6.0.0
[5.6.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.6.0...v5.6.1
[5.6.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.5.0...v5.6.0
[5.5.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.4.1...v5.5.0
[5.4.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.4.0...v5.4.1
[5.4.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.3.0...v5.4.0
[5.3.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.2.0...v5.3.0
[5.2.0]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.16...v5.2.0
[5.1.16]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.15...v5.1.16
[5.1.15]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.14...v5.1.15
[5.1.14]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.13...v5.1.14
[5.1.13]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.12...v5.1.13
[5.1.12]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.11...v5.1.12
[5.1.11]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.10...v5.1.11
[5.1.10]:
https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.9...v5.1.10
[5.1.9]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.8...v5.1.9
[5.1.8]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.7...v5.1.8
[5.1.7]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.6...v5.1.7
[5.1.6]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.5...v5.1.6
[5.1.5]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.4...v5.1.5
[5.1.4]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.3...v5.1.4
[5.1.3]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.2...v5.1.3
[5.1.2]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.1...v5.1.2
[5.1.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.1.0...v5.1.1
[5.1.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.0.3...v5.1.0
[5.0.3]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.0.2...v5.0.3
[5.0.2]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.0.1...v5.0.2
[5.0.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v5.5.0...v5.0.1
[5.0.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v4.5.1...v5.0.0
[4.5.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v4.5.0...v4.5.1
[4.5.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v4.4.0...v4.5.0
[4.4.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v4.3.1...v4.4.0
[4.3.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v4.3.0...v4.3.1
[4.3.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v4.2.0...v4.3.0
[4.2.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v4.1.0...v4.2.0
[4.1.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v4.0.0...v4.1.0
[4.0.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v3.4.0...v4.0.0
[3.4.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v3.2.0...v3.4.0
[3.2.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v3.1.1...v3.2.0
[3.1.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v3.1.0...v3.1.1
[3.1.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v3.0.0...v3.1.0
[3.0.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v2.1.1...v3.0.0
[2.1.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v2.1.0...v2.1.1
[2.1.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v2.0.0...v2.1.0
[2.0.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v1.4.0...v2.0.0
[1.4.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v1.3.3...v1.4.0
[1.3.3]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v1.3.2...v1.3.3
[1.3.2]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v1.3.1...v1.3.2
[1.3.1]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v1.2.0...v1.3.1
[1.2.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v1.1.0...v1.2.0
[1.1.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v1.0.0...v1.1.0
[1.0.0]: https://gitlab.nic.cz/turris/reforis/foris-js/-/compare/v0.0.7...v1.0.0
[0.0.7]: https://gitlab.nic.cz/turris/reforis/foris-js/-/tags/v0.0.7

View File

@ -1,31 +1,20 @@
# Copyright (C) 2019-2022 CZ.NIC z.s.p.o. (https://www.nic.cz/) .PHONY: all install-js watch-js build-js collect-files pack publish-beta publish-latest lint test test-js-update-snapshots create-messages update-messages docs docs-watch clean
#
# This is free software, licensed under the GNU General Public License v3.
# See /LICENSE for more information.
PROJECT="Foris JS" DEV_PYTHON=python3.7
# Retrieve Foris JS version from package.json
VERSION= $(shell sed -En "s/.*version['\"]: ['\"](.+)['\"].*/\1/p" package.json)
COPYRIGHT_HOLDER="CZ.NIC, z.s.p.o. (https://www.nic.cz/)"
MSGID_BUGS_ADDRESS="tech.support@turris.cz"
DEV_PYTHON=python3
VENV_NAME?=venv VENV_NAME?=venv
JS_DIR=js
VENV_BIN=$(shell pwd)/$(VENV_NAME)/bin VENV_BIN=$(shell pwd)/$(VENV_NAME)/bin
.PHONY: all
all: all:
@echo "make install-js" @echo "make install-js"
@echo " Install npm dependencies." @echo " Install dependencies"
@echo "make lint" @echo "make watch-js"
@echo " Run linter on the project." @echo " Compile JS in watch mode."
@echo "make test" @echo "make build-js"
@echo " Run tests on the project." @echo " Compile JS."
@echo "make test-js-watch" @echo "make lint-js"
@echo " Run tests on the project in watch mode." @echo " Run linter"
@echo "make test-js-update-snapshots" @echo "make test-js"
@echo " Update snapshots." @echo " Run tests"
@echo "make create-messages" @echo "make create-messages"
@echo " Create locale messages (.pot)." @echo " Create locale messages (.pot)."
@echo "make update-messages" @echo "make update-messages"
@ -37,93 +26,43 @@ all:
@echo "make clean" @echo "make clean"
@echo " Remove python artifacts and virtualenv." @echo " Remove python artifacts and virtualenv."
# Preparation
.PHONY: venv
venv: $(VENV_NAME)/bin/activate venv: $(VENV_NAME)/bin/activate
$(VENV_NAME)/bin/activate: $(VENV_NAME)/bin/activate:
test -d $(VENV_NAME) || $(DEV_PYTHON) -m virtualenv -p $(DEV_PYTHON) $(VENV_NAME) test -d $(VENV_NAME) || $(DEV_PYTHON) -m virtualenv -p $(DEV_PYTHON) $(VENV_NAME)
$(VENV_BIN)/$(DEV_PYTHON) -m pip install -r requirements.txt $(VENV_BIN)/$(DEV_PYTHON) -m pip install -r requirements.txt
touch $(VENV_NAME)/bin/activate touch $(VENV_NAME)/bin/activate
# Installation
.PHONY: install-js
install-js: package.json install-js: package.json
npm install --save-dev npm install --save-dev
# Publishing
.PHONY: collect-files
collect-files: collect-files:
sh scripts/collect_files.sh sh scripts/collect_files.sh
.PHONY: pack
pack: collect-files pack: collect-files
cd dist && npm pack cd dist && npm pack
.PHONY: publish-beta
publish-beta: collect-files publish-beta: collect-files
sh scripts/publish.sh beta sh scripts/publish.sh beta
.PHONY: publish-latest
publish-latest: collect-files publish-latest: collect-files
sh scripts/publish.sh latest sh scripts/publish.sh latest
# Linting
.PHONY: lint
lint: lint:
npm run lint npm run lint
.PHONY: lint-js-fix
lint-js-fix: lint-js-fix:
npm run lint:fix npm run lint:fix
# Testing
.PHONY: test
test: test:
npm test npm test
.PHONY: test-js-watch
test-js-watch:
cd $(JS_DIR); npm test -- --watch
.PHONY: test-js-update-snapshots
test-js-update-snapshots: test-js-update-snapshots:
npm test -- -u npm test -- -u
# Translations
.PHONY: create-messages
create-messages: venv create-messages: venv
$(VENV_BIN)/pybabel extract -F babel.cfg -o ./translations/forisjs.pot . --project=$(PROJECT) --version=$(VERSION) --copyright-holder=$(COPYRIGHT_HOLDER) --msgid-bugs-address=$(MSGID_BUGS_ADDRESS) $(VENV_BIN)/pybabel extract -F babel.cfg -o ./translations/forisjs.pot .
.PHONY: update-messages
update-messages: venv update-messages: venv
$(VENV_BIN)/pybabel update -i ./translations/forisjs.pot -d ./translations -D forisjs --update-header-comment $(VENV_BIN)/pybabel update -i ./translations/forisjs.pot -d ./translations -D forisjs
# Documentation
.PHONY: docs
docs: docs:
npm run-script docs npm run-script docs
.PHONY: docs-watch
docs-watch: docs-watch:
npm run-script docs:watch npm run-script docs:watch
# Other
.PHONY: clean
clean: clean:
rm -rf node_modules dist rm -rf node_modules dist

View File

@ -1,5 +1,4 @@
# foris-js # foris-js
Set of utils and common React elements for reForis. Set of utils and common React elements for reForis.
## Publishing package ## Publishing package
@ -14,20 +13,17 @@ tagged `beta`. Versions names are based on commit SHA, e.g.
1. Crete a merge request to `dev` branch with version bumped 1. Crete a merge request to `dev` branch with version bumped
2. When merging add `[skip ci]` to commit message to prevent publishing 2. When merging add `[skip ci]` to commit message to prevent publishing
unnecessary version unnecessary version
3. Create a merge request from `dev` to `master` branch 3. Create a merge request from `dev` to `master` branch
4. New version should be published automatically 4. New version should be published automatically
## Manually managed dependencies ## Manually managed dependencies
Because of `<ForisForm />` component it's required to use exposed `ReactRouterDOM`
Because of `<ForisForm />` component it's required to use exposed object from `react-router-dom` library. `ReactRouterDOM` is exposed by
`ReactRouterDOM` object from `react-router-dom` library. `ReactRouterDOM` is
exposed by
[reForis](https://gitlab.labs.nic.cz/turris/reforis/reforis/blob/master/js/webpack.config.js). [reForis](https://gitlab.labs.nic.cz/turris/reforis/reforis/blob/master/js/webpack.config.js).
It can be done by following steps: It can be done by following steps:
1. Setting `react-router-dom` as `peerDependencies` and `devDependencies` in 1. Setting `react-router-dom` as `peerDependencies` and `devDependencies` in `package.json`.
`package.json`.
2. Adding the following rules to `externals` in `webpack.conf.js` of the plugin: 2. Adding the following rules to `externals` in `webpack.conf.js` of the plugin:
```js ```js
@ -38,15 +34,11 @@ externals: {
``` ```
### Docs ### Docs
Build or watch docs to get more info about library: Build or watch docs to get more info about library:
```bash ```bash
make docs make docs
``` ```
or or
```bash ```bash
make docs-watch make docs-watch
``` ```

View File

@ -1,4 +1,9 @@
module.exports = { module.exports = {
presets: ["@babel/preset-env", "@babel/preset-react"], presets: [
plugins: ["@babel/plugin-transform-runtime"], "@babel/preset-env",
"@babel/preset-react",
],
plugins: [
"@babel/plugin-transform-runtime",
],
}; };

View File

@ -1,36 +0,0 @@
import React from "react";
import PropTypes from "prop-types";
import Styled from "rsg-components/Styled";
import logo from "./logo.svg";
const styles = ({ fontFamily }) => ({
logo: {
display: "flex",
alignItems: "center",
margin: 0,
fontFamily: fontFamily.base,
fontSize: 18,
fontWeight: "normal",
},
image: {
height: "1.3em",
marginLeft: "-0.2em",
marginRight: "0.2em",
},
});
export function LogoRenderer({ classes, children }) {
return (
<h1 className={classes.logo}>
<img className={classes.image} src={logo} alt="React logo" />
{children}
</h1>
);
}
LogoRenderer.propTypes = {
classes: PropTypes.object.isRequired,
children: PropTypes.node,
};
export default Styled(styles)(LogoRenderer);

View File

@ -1,3 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" width="1000" height="1000">
<path d="M288.258 240.0394L717.5586-.44c.803 62.277-1.8207 124.502-1.4996 186.7266 1.8208 7.6343-7.2288 10.1966-12.102 13.4908L286.4375 432.1518l1.8206-192.1124zm2.284 277.645L711 278.3176l-.8416 192.7742L457.357 614.514l-1.842 289.03-167.7097 95.8926 2.7365-481.753z"/>
</svg>

Before

Width:  |  Height:  |  Size: 349 B

View File

@ -1,15 +1,12 @@
Sooner or later, you will face with situation when you want/need to make some Sooner or later you will face with situation when you want/need to make some changes in the library.
changes in the library. Then the most important tool for you it's the Then the most important tool for you it's [`npm link`](https://docs.npmjs.com/cli/link).
[`npm link`](https://docs.npmjs.com/cli/link).
Please, notice that it will not work if you link the library just from the root Please, notice that it will not work if you link library just from root of the repo. It happens due to location of
of the repo. It happens due to the location of sources `./src`. You need to pack sources `./src`. You need to pack library first `make pack` and then link it from `./dist` directory.
the library first, `make pack` and then link it from the `./dist` directory.
Yeah, it's not such a comfortable solution for development. But it can be fixed Yeah it's not such comfortable solution for development. But it can fixed by writing small script similar as `make pack`
by writing a small script similar to making a pack but by linking every file and but with linking every file and directory from `./src` to the some directory and linking then from it. Notice that you
directory from `./src` to the same directory and linking then from it. Notice need to link `package.json` and `package-lock.json` as well.
that you need to link a `package.json` and a `package-lock.json` as well.
So step by step: So step by step:

View File

@ -1,4 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" width="500" height="500" fill="white">
<path d="M49.5 171.722222222222h400v133.333333333333h-200v22.222222222223h-88.888888888889v-22.222222222223H49.5V171.722222222222zm22.222222222222 111.111111111111h44.444444444445v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-88.888888888889H71.722222222222v88.888888888889zm111.111111111111-88.888888888889v111.111111111111h44.444444444445v-22.222222222222h44.444444444444v-88.888888888889h-88.888888888889zm44.444444444445 22.222222222222H249.5v44.444444444445h-22.222222222222v-44.444444444445zm66.666666666666-22.222222222222v88.888888888889h44.444444444445v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-66.666666666667h22.222222222222v66.666666666667h22.222222222223v-88.888888888889H293.944444444444z" fill="#cb3837" />
<path d="M71.722222222222 282.833333333333h44.444444444444v-66.666666666667h22.222222222223v66.666666666667h22.222222222222v-88.888888888889H71.722222222222zm111.111111111111-88.888888888889v111.111111111111h44.444444444444v-22.222222222222h44.444444444445v-88.888888888889h-88.888888888889zM249.5 260.611111111111h-22.222222222223v-44.444444444445H249.5v44.444444444445zm44.444444444444-66.666666666667v88.888888888889h44.444444444444v-66.666666666667h22.222222222223v66.666666666667h22.222222222222v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-88.888888888889z" />
</svg>

Before

Width:  |  Height:  |  Size: 1.4 KiB

4
docs/intro.md Normal file
View File

@ -0,0 +1,4 @@
Foris JS library is set of components and utils for Foris JS application and plugins.
Please notice that all of these components or utils are used in reForis and plugins. If you like to study by example I would
recommend to full-text search these repos.

View File

@ -1,37 +0,0 @@
Welcome! This is the official documentation for Foris JS.
## What Foris JS is
Foris JS library is a set of components and utils for reForis application and
plugins.
Please notice that all of these components or utils are used in reForis and
plugins. If you want to study them by example, I recommend you to full-text
search those repositories.
# Installation
## Prerequisites
Please make sure that [Node.js](https://nodejs.org/en/) is installed on your
system.
The current Long Term Support (LTS) release is an ideal starting point, see
[here](https://github.com/nodejs/Release#release-schedule).
## Installation
To install the latest release:
```plain
npm install foris
```
To install a specific version:
```plain
npm install foris@version
```
<a target="_blank" href="https://www.npmjs.com/package/foris">Check
on<img width="100px" src="./docs/forisjs-npm.svg"></a>

View File

@ -19,7 +19,6 @@ module.exports = {
collectCoverageFrom: ["src/**/*.{js,jsx}"], collectCoverageFrom: ["src/**/*.{js,jsx}"],
coverageDirectory: "coverage", coverageDirectory: "coverage",
testPathIgnorePatterns: ["/node_modules/", "/__fixtures__/", "/dist/"], testPathIgnorePatterns: ["/node_modules/", "/__fixtures__/", "/dist/"],
testEnvironment: "jsdom",
verbose: false, verbose: false,
setupFilesAfterEnv: [ setupFilesAfterEnv: [
"@testing-library/react/cleanup-after-each", "@testing-library/react/cleanup-after-each",
@ -28,5 +27,7 @@ module.exports = {
globals: { globals: {
TZ: "utc", TZ: "utc",
}, },
transformIgnorePatterns: ["node_modules/(?!(react-datetime)/)"], transformIgnorePatterns: [
"node_modules/(?!(react-datetime)/)",
],
}; };

42032
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,11 +1,11 @@
{ {
"name": "foris", "name": "foris",
"version": "6.1.0", "version": "5.0.2",
"description": "Foris JS library is a set of components and utils for reForis application and plugins.", "description": "Set of components and utils for Foris and its plugins.",
"author": "CZ.NIC, z.s.p.o.", "author": "CZ.NIC, z.s.p.o.",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://gitlab.nic.cz/turris/reforis/foris-js.git" "url": "https://gitlab.labs.nic.cz/turris/reforis/foris-js.git"
}, },
"keywords": [ "keywords": [
"foris", "foris",
@ -14,51 +14,46 @@
"license": "GPL-3.0", "license": "GPL-3.0",
"main": "./src/index.js", "main": "./src/index.js",
"dependencies": { "dependencies": {
"@fortawesome/fontawesome-svg-core": "^6.6.0", "axios": "^0.19.2",
"@fortawesome/free-regular-svg-icons": "^6.6.0", "immutability-helper": "3.0.1",
"@fortawesome/free-solid-svg-icons": "^6.6.0", "moment": "^2.24.0",
"@fortawesome/react-fontawesome": "^0.2.2", "qrcode.react": "^0.9.3",
"axios": "^1.7.2", "react-datetime": "^2.16.3",
"immutability-helper": "^3.1.1", "react-uid": "^2.2.0"
"moment": "^2.30.1",
"qrcode.react": "^3.1.0",
"react-datetime": "^3.2.0",
"react-uid": "^2.3.3"
}, },
"peerDependencies": { "peerDependencies": {
"bootstrap": "^5.3.3", "bootstrap": "4.4.1",
"prop-types": "15.8.1", "prop-types": "15.7.2",
"react": "16.9.0", "react": "16.9.0",
"react-dom": "16.9.0", "react-dom": "16.9.0",
"react-router-dom": "^5.1.2" "react-router-dom": "^5.1.2"
}, },
"devDependencies": { "devDependencies": {
"@babel/cli": "^7.24.7", "@babel/cli": "^7.8.4",
"@babel/core": "^7.24.7", "@babel/core": "^7.9.0",
"@babel/plugin-transform-runtime": "^7.24.7", "@babel/plugin-transform-runtime": "^7.9.0",
"@babel/preset-env": "^7.24.7", "@babel/preset-env": "^7.9.0",
"@babel/preset-react": "^7.24.7", "@babel/preset-react": "^7.9.4",
"@fortawesome/fontawesome-free": "^5.13.0",
"@testing-library/react": "^8.0.9", "@testing-library/react": "^8.0.9",
"babel-loader": "^8.1.0", "babel-loader": "^8.1.0",
"babel-polyfill": "^6.26.0", "babel-polyfill": "^6.26.0",
"bootstrap": "^5.3.3", "bootstrap": "^4.5.0",
"css-loader": "^5.2.4", "css-loader": "^3.5.3",
"eslint": "^8.57.0", "eslint": "^6.8.0",
"eslint-config-reforis": "^2.1.1", "eslint-config-reforis": "^1.0.0",
"file-loader": "^6.0.0", "file-loader": "^6.0.0",
"jest": "^29.7.0", "jest": "^25.2.0",
"jest-environment-jsdom": "^29.7.0", "jest-mock-axios": "^3.2.0",
"jest-mock-axios": "^4.7.3", "moment-timezone": "^0.5.28",
"moment-timezone": "^0.5.45", "prop-types": "15.7.2",
"prettier": "^3.3.2",
"prop-types": "15.8.1",
"react": "16.9.0", "react": "16.9.0",
"react-dom": "16.9.0", "react-dom": "16.9.0",
"react-router-dom": "^5.1.2", "react-router-dom": "^5.1.2",
"react-styleguidist": "^12.0.1", "react-styleguidist": "^10.6.2",
"snapshot-diff": "^0.10.0", "snapshot-diff": "^0.7.0",
"style-loader": "^1.2.1", "style-loader": "^1.2.1",
"webpack": "^5.92.1" "webpack": "^4.43.0"
}, },
"scripts": { "scripts": {
"lint": "eslint src", "lint": "eslint src",

View File

@ -1 +0,0 @@
module.exports = require("eslint-config-reforis/prettier.config");

View File

@ -6,7 +6,8 @@ then
exit 1 exit 1
else else
cd dist cd dist
echo "//registry.npmjs.org/:_authToken=$(echo "$NPM_TOKEN")" > .npmrc # Need to replace "_" with "-" as GitLab CI won't accept secret vars with "-"
echo "//registry.npmjs.org/:_authToken=$(echo "$NPM_TOKEN" | tr _ -)" > .npmrc
echo "unsafe-perm = true" >> ~/.npmrc echo "unsafe-perm = true" >> ~/.npmrc
if test "$1" = "beta" if test "$1" = "beta"
then then

View File

@ -1,16 +1,15 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React, { useState, useContext, useCallback, useMemo } from "react"; import React, { useState, useContext, useCallback } from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import Alert, { ALERT_TYPES } from "../../bootstrap/Alert"; import { Alert, ALERT_TYPES } from "../bootstrap/Alert";
import Portal from "../../utils/Portal"; import { Portal } from "../utils/Portal";
AlertContextProvider.propTypes = { AlertContextProvider.propTypes = {
children: PropTypes.oneOfType([ children: PropTypes.oneOfType([
@ -23,18 +22,11 @@ function AlertContextProvider({ children }) {
const { AlertContext } = window; const { AlertContext } = window;
const [alert, setAlert] = useState(null); const [alert, setAlert] = useState(null);
const setAlertWrapper = useCallback( const setAlertWrapper = useCallback((message, type = ALERT_TYPES.DANGER) => {
(message, type = ALERT_TYPES.DANGER) => {
setAlert({ message, type }); setAlert({ message, type });
}, }, [setAlert]);
[setAlert]
);
const dismissAlert = useCallback(() => setAlert(null), [setAlert]); const dismissAlert = useCallback(() => setAlert(null), [setAlert]);
const contextValue = useMemo(
() => [setAlertWrapper, dismissAlert],
[setAlertWrapper, dismissAlert]
);
return ( return (
<> <>
@ -45,8 +37,8 @@ function AlertContextProvider({ children }) {
</Alert> </Alert>
</Portal> </Portal>
)} )}
<AlertContext.Provider value={contextValue}> <AlertContext.Provider value={[setAlertWrapper, dismissAlert]}>
{children} { children }
</AlertContext.Provider> </AlertContext.Provider>
</> </>
); );

View File

@ -1,5 +1,4 @@
It provides alert context to children. `AlertContext` allows using `useAlert` in It provides alert context to children. `AlertContext` allows using `useAlert` in components.
components.
Notice that `<div id="alert-container"/>` should be presented in HTML doc to get Notice that `<div id="alert-container"/>` should be presented in HTML doc to get it work (In reForis it's already done
it work (In reForis it's already done with base Jinja2 templates). with base Jinja2 templates).

View File

@ -6,7 +6,9 @@
*/ */
import React from "react"; import React from "react";
import { render, getByText, queryByText, fireEvent } from "customTestRender"; import {
render, getByText, queryByText, fireEvent,
} from "customTestRender";
import { useAlert, AlertContextProvider } from "../AlertContext"; import { useAlert, AlertContextProvider } from "../AlertContext";
@ -29,7 +31,7 @@ describe("AlertContext", () => {
const { container } = render( const { container } = render(
<AlertContextProvider> <AlertContextProvider>
<AlertTest /> <AlertTest />
</AlertContextProvider> </AlertContextProvider>,
); );
componentContainer = container; componentContainer = container;
}); });
@ -48,7 +50,7 @@ describe("AlertContext", () => {
// Alert is present // Alert is present
expect(getByText(componentContainer, "Alert content")).toBeDefined(); expect(getByText(componentContainer, "Alert content")).toBeDefined();
fireEvent.click(componentContainer.querySelector(".btn-close")); fireEvent.click(componentContainer.querySelector(".close"));
// Alert is gone // Alert is gone
expect(queryByText(componentContainer, "Alert content")).toBeNull(); expect(queryByText(componentContainer, "Alert content")).toBeNull();
}); });

View File

@ -6,13 +6,14 @@ exports[`AlertContext should render alert 1`] = `
id="alert-container" id="alert-container"
> >
<div <div
class="alert alert-danger alert-dismissible" class="alert alert-dismissible alert-danger"
> >
<button <button
aria-label="Close" class="close"
class="btn-close"
type="button" type="button"
/> >
×
</button>
Alert content Alert content
</div> </div>
</div> </div>

View File

@ -1,19 +1,17 @@
/* /*
* Copyright (C) 2019-2021 CZ.NIC z.s.p.o. (http://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import { useCallback, useEffect, useReducer, useState } from "react";
import { import {
API_ACTIONS, useCallback, useEffect, useReducer, useState,
API_METHODS, } from "react";
API_STATE,
getErrorPayload, import { ForisURLs } from "../utils/forisUrls";
HEADERS, import {
TIMEOUT, API_ACTIONS, API_METHODS, API_STATE, getErrorPayload, HEADERS, TIMEOUT,
} from "./utils"; } from "./utils";
const DATA_METHODS = ["POST", "PATCH", "PUT"]; const DATA_METHODS = ["POST", "PATCH", "PUT"];
@ -25,8 +23,7 @@ function createAPIHook(method) {
data: null, data: null,
}); });
const sendRequest = useCallback( const sendRequest = useCallback(async ({ data, suffix } = {}) => {
async ({ data, suffix } = {}) => {
const headers = { ...HEADERS }; const headers = { ...HEADERS };
if (contentType) { if (contentType) {
headers["Content-Type"] = contentType; headers["Content-Type"] = contentType;
@ -63,9 +60,7 @@ function createAPIHook(method) {
payload: errorPayload, payload: errorPayload,
}); });
} }
}, }, [urlRoot, contentType]);
[urlRoot, contentType]
);
return [state, sendRequest]; return [state, sendRequest];
}; };
} }
@ -83,17 +78,13 @@ function APIReducer(state, action) {
data: action.payload, data: action.payload,
}; };
case API_ACTIONS.FAILURE: case API_ACTIONS.FAILURE:
if (action.status === 401) { if (action.status === 403) {
window.location.reload(); window.location.assign(ForisURLs.login);
} }
// Not an API error - should be rethrown. // Not an API error - should be rethrown.
if ( if (action.payload && action.payload.stack && action.payload.message) {
action.payload && throw (action.payload);
action.payload.stack &&
action.payload.message
) {
throw action.payload;
} }
return { return {
@ -111,9 +102,11 @@ const useAPIPatch = createAPIHook("PATCH");
const useAPIPut = createAPIHook("PUT"); const useAPIPut = createAPIHook("PUT");
const useAPIDelete = createAPIHook("DELETE"); const useAPIDelete = createAPIHook("DELETE");
/* eslint-disable default-param-last */ export {
function useAPIPolling(endpoint, delay = 1000, until) { useAPIGet, useAPIPost, useAPIPatch, useAPIPut, useAPIDelete,
// delay ms };
export function useAPIPolling(endpoint, delay = 1000, until) { // delay ms
const [state, setState] = useState({ state: API_STATE.INIT }); const [state, setState] = useState({ state: API_STATE.INIT });
const [getResponse, get] = useAPIGet(endpoint); const [getResponse, get] = useAPIGet(endpoint);
@ -132,12 +125,3 @@ function useAPIPolling(endpoint, delay = 1000, until) {
return [state]; return [state];
} }
export {
useAPIGet,
useAPIPost,
useAPIPatch,
useAPIPut,
useAPIDelete,
useAPIPolling,
};

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (C) 2019-2021 CZ.NIC z.s.p.o. (http://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
@ -11,7 +11,6 @@ export const HEADERS = {
Accept: "application/json", Accept: "application/json",
"Content-Type": "application/json", "Content-Type": "application/json",
"X-CSRFToken": getCookie("_csrf_token"), "X-CSRFToken": getCookie("_csrf_token"),
"X-Requested-With": "json",
}; };
export const TIMEOUT = 30500; export const TIMEOUT = 30500;
@ -44,10 +43,8 @@ function getCookie(name) {
for (let i = 0; i < cookies.length; i++) { for (let i = 0; i < cookies.length; i++) {
const cookie = cookies[i].trim(); const cookie = cookies[i].trim();
// Does this cookie string begin with the name we want? // Does this cookie string begin with the name we want?
if (cookie.substring(0, name.length + 1) === `${name}=`) { if (cookie.substring(0, name.length + 1) === (`${name}=`)) {
cookieValue = decodeURIComponent( cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
cookie.substring(name.length + 1)
);
break; break;
} }
} }
@ -57,7 +54,7 @@ function getCookie(name) {
export function getErrorPayload(error) { export function getErrorPayload(error) {
if (error.response) { if (error.response) {
if (error.response.status === 401) { if (error.response.status === 403) {
return _("The session is expired. Please log in again."); return _("The session is expired. Please log in again.");
} }
return getJSONErrorMessage(error); return getJSONErrorMessage(error);

View File

@ -1,12 +1,11 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
export const ALERT_TYPES = Object.freeze({ export const ALERT_TYPES = Object.freeze({
@ -36,24 +35,13 @@ Alert.defaultProps = {
type: ALERT_TYPES.DANGER, type: ALERT_TYPES.DANGER,
}; };
function Alert({ type, onDismiss, children }) { export function Alert({
type, onDismiss, children,
}) {
return ( return (
<div <div className={`alert alert-dismissible alert-${type}`}>
className={`alert alert-${type} ${ {onDismiss ? <button type="button" className="close" onClick={onDismiss}>&times;</button> : false}
onDismiss ? "alert-dismissible" : ""
}`.trim()}
>
{onDismiss && (
<button
type="button"
className="btn-close"
onClick={onDismiss}
aria-label={_("Close")}
/>
)}
{children} {children}
</div> </div>
); );
} }
export default Alert;

View File

@ -1,21 +1,21 @@
Bootstrap alert component. Bootstrap alert component.
```jsx ```jsx
import { useState } from "react"; import {useState} from 'react';
function AlertExample() { function AlertExample(){
const [alert, setAlert] = useState(true); const [alert, setAlert] = useState(true);
if (alert) if (alert)
return ( return <Alert
<Alert type="warning" onDismiss={() => setAlert(false)}> type='warning'
onDismiss={()=>setAlert(false)}
>
Some warning out there! Some warning out there!
</Alert> </Alert>;
); return <button
return ( className='btn btn-secondary'
<button className="btn btn-secondary" onClick={() => setAlert(true)}> onClick={()=>setAlert(true)}
Show alert again >Show alert again</button>;
</button> };
); <AlertExample/>
}
<AlertExample />;
``` ```

View File

@ -1,12 +1,11 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
Button.propTypes = { Button.propTypes = {
@ -25,28 +24,24 @@ Button.propTypes = {
]).isRequired, ]).isRequired,
}; };
function Button({ className, loading, forisFormSize, children, ...props }) { export function Button({
let buttonClass = className ? `btn ${className}` : "btn btn-primary"; className, loading, forisFormSize, children, ...props
}) {
let buttonClass = className ? `btn ${className}` : "btn btn-primary ";
if (forisFormSize) { if (forisFormSize) {
buttonClass = `${buttonClass} col-12 col-md-3 col-lg-2`; buttonClass = `${buttonClass} col-sm-12 col-lg-3`;
} }
const span = loading
? <span className="spinner-border spinner-border-sm" role="status" aria-hidden="true" /> : null;
return ( return (
<button <button type="button" className={buttonClass} {...props}>
type="button" {span}
className={`${buttonClass} d-inline-flex justify-content-center align-items-center`} {" "}
{...props} {span ? " " : null}
> {" "}
{loading && ( {children}
<span
className="spinner-border spinner-border-sm me-1"
role="status"
aria-hidden="true"
/>
)}
<span>{children}</span>
</button> </button>
); );
} }
export default Button;

View File

@ -11,7 +11,5 @@ Can be used without parameters:
Using loading spinner: Using loading spinner:
```jsx ```jsx
<Button loading disabled> <Button loading disabled>Loading...</Button>
Loading...
</Button>
``` ```

View File

@ -1,12 +1,11 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { useUID } from "react-uid"; import { useUID } from "react-uid";
@ -17,36 +16,32 @@ CheckBox.propTypes = {
helpText: PropTypes.string, helpText: PropTypes.string,
/** Control if checkbox is clickable */ /** Control if checkbox is clickable */
disabled: PropTypes.bool, disabled: PropTypes.bool,
/** Additional class name */
className: PropTypes.string,
}; };
CheckBox.defaultProps = { CheckBox.defaultProps = {
disabled: false, disabled: false,
}; };
function CheckBox({ label, helpText, disabled, className, ...props }) { export function CheckBox({
label, helpText, disabled, ...props
}) {
const uid = useUID(); const uid = useUID();
return ( return (
<div className={`${className || "mb-3"} form-check`.trim()}> <div className="form-group">
<div className="custom-control custom-checkbox ">
<input <input
className="form-check-input" className="custom-control-input"
type="checkbox" type="checkbox"
id={uid} id={uid}
disabled={disabled} disabled={disabled}
{...props} {...props}
/> />
<label className="form-check-label" htmlFor={uid}> <label className="custom-control-label" htmlFor={uid}>
{label} {label}
{helpText && <small className="form-text text-muted">{helpText}</small>}
</label> </label>
{helpText && (
<div className="form-text">
<small>{helpText}</small>
</div> </div>
)}
</div> </div>
); );
} }
export default CheckBox;

View File

@ -1,17 +1,16 @@
Checkbox with label Bootstrap component with predefined sizes and structure for Checkbox with label Bootstrap component with predefined sizes and structure for using in foris forms.
using in foris forms.
All additional `props` are passed to the `<input type="checkbox">` HTML component.
All additional `props` are passed to the `<input type="checkbox">` HTML
component.
```js ```js
import { useState } from "react"; import {useState} from 'react';
const [value, setValue] = useState(false); const [value, setValue] = useState(false);
<CheckBox <CheckBox
value={value} value={value}
label="Some label" label="Some label"
helpText="Read the small text!" helpText="Read the small text!"
onChange={(event) => setValue(event.target.value)} onChange={event =>setValue(event.target.value)}
/>; />
``` ```

View File

@ -1,64 +0,0 @@
/*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/)
*
* This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information.
*/
import React, { useState, useRef } from "react";
import PropTypes from "prop-types";
import Input from "./Input";
CopyInput.propTypes = {
/** Field label. */
label: PropTypes.string.isRequired,
/** Field value. */
value: PropTypes.string,
/** Help text message. */
helpText: PropTypes.string,
/** Disable input field */
disabled: PropTypes.bool,
/** Readonly input field */
readOnly: PropTypes.bool,
};
function CopyInput({ value, ...props }) {
const inputTextRef = useRef();
const [isCopied, setIsCopied] = useState(false);
const handleCopyClick = async () => {
// Clipboard API works only in a secure (HTTPS) context.
if (navigator.clipboard) {
await navigator.clipboard.writeText(value);
} else {
// Fallback to the "classic" copy to clipboard implementation.
inputTextRef.current.focus();
inputTextRef.current.select();
document.execCommand("copy");
inputTextRef.current.blur();
}
setIsCopied(true);
setTimeout(() => {
setIsCopied(false);
}, 1500);
};
return (
<Input type="text" value={value} ref={inputTextRef} {...props}>
<div className="input-group-append">
<button
className="btn btn-outline-secondary"
type="button"
onClick={handleCopyClick}
>
<span>{isCopied ? _("Copied!") : _("Copy")}</span>
</button>
</div>
</Input>
);
}
export default CopyInput;

View File

@ -1,17 +0,0 @@
CopyInput Bootstrap component contains input with a label, predefined sizes, and
structure for use in ForisForm and the "Copy" button (copy to clipboard). It can
be used with `readOnly` and `disabled` parameters, please see an example.
All additional `props` are passed to the `<input type="text">` HTML component.
```js
import React, { useState } from "react";
const [value, setValue] = useState("Text to appear in clipboard.");
<CopyInput
label="Copy me"
value={value}
helpText="Read the small text!"
readOnly
/>;
```

View File

@ -1,19 +1,18 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import moment from "moment/moment";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import Datetime from "react-datetime"; import Datetime from "react-datetime/DateTime";
import moment from "moment/moment";
import "react-datetime/css/react-datetime.css"; import "react-datetime/css/react-datetime.css";
import "./DataTimeInput.css"; import "./DataTimeInput.css";
import Input from "./Input"; import { Input } from "./Input";
DataTimeInput.propTypes = { DataTimeInput.propTypes = {
/** Field label. */ /** Field label. */
@ -38,32 +37,25 @@ DataTimeInput.propTypes = {
const DEFAULT_DATE_FORMAT = "YYYY-MM-DD"; const DEFAULT_DATE_FORMAT = "YYYY-MM-DD";
const DEFAULT_TIME_FORMAT = "HH:mm:ss"; const DEFAULT_TIME_FORMAT = "HH:mm:ss";
function DataTimeInput({ export function DataTimeInput({
value, value, onChange, isValidDate, dateFormat, timeFormat, children, ...props
onChange,
isValidDate,
dateFormat,
timeFormat,
children,
...props
}) { }) {
const renderInput = (datetimeProps) => { function renderInput(datetimeProps) {
return ( return (
<Input {...props} {...datetimeProps}> <Input
{...props}
{...datetimeProps}
>
{children} {children}
</Input> </Input>
); );
}; }
return ( return (
<Datetime <Datetime
locale={ForisTranslations.locale} locale={ForisTranslations.locale}
dateFormat={ dateFormat={dateFormat !== undefined ? dateFormat : DEFAULT_DATE_FORMAT}
dateFormat !== undefined ? dateFormat : DEFAULT_DATE_FORMAT timeFormat={timeFormat !== undefined ? timeFormat : DEFAULT_TIME_FORMAT}
}
timeFormat={
timeFormat !== undefined ? timeFormat : DEFAULT_TIME_FORMAT
}
value={value} value={value}
onChange={onChange} onChange={onChange}
isValidDate={isValidDate} isValidDate={isValidDate}
@ -71,5 +63,3 @@ function DataTimeInput({
/> />
); );
} }
export default DataTimeInput;

View File

@ -1,26 +1,25 @@
Adopted from `react-datetime/DateTime` datatime picker component. It uses Adopted from `react-datetime/DateTime` datatime picker component.
`momentjs` see example. It uses `momentjs` see example.
It requires `ForisTranslations.locale` to be defined in order to use right It requires `ForisTranslations.locale` to be defined in order to use right locale.
locale.
```js ```js
ForisTranslations = { locale: "en" }; ForisTranslations={locale:'en'};
import { useState, useEffect } from "react"; import {useState, useEffect} from 'react';
import moment from "moment/moment"; import moment from 'moment/moment';
const [dataTime, setDataTime] = useState(moment()); const [dataTime, setDataTime] = useState(moment());
const [error, setError] = useState(); const [error, setError] = useState();
useEffect(() => { useEffect(()=>{
dataTime.isValid() ? setError(null) : setError("Invalid value!"); dataTime.isValid() ? setError(null) : setError('Invalid value!');
}, [dataTime]); },[dataTime]);
<DataTimeInput <DataTimeInput
label="Time to sleep" label='Time to sleep'
value={dataTime} value={dataTime}
error={error} error={error}
helpText="Example helptext..." helpText='Example helptext...'
onChange={(value) => setDataTime(value)} onChange={value => setDataTime(value)}
/>; />
``` ```

View File

@ -1,12 +1,11 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
DownloadButton.propTypes = { DownloadButton.propTypes = {
@ -22,17 +21,14 @@ DownloadButton.defaultProps = {
className: "btn-primary", className: "btn-primary",
}; };
function DownloadButton({ href, className, children, ...props }) { export function DownloadButton({ href, className, children }) {
return ( return (
<a <a
href={href} href={href}
className={`btn ${className}`.trim()} className={`btn ${className}`.trim()}
{...props}
download download
> >
{children} {children}
</a> </a>
); );
} }
export default DownloadButton;

View File

@ -1,9 +1,6 @@
Hyperlink with apperance of a button. Hyperlink with apperance of a button.
It has `download` attribute, which prevents closing WebSocket connection on It has `download` attribute, which prevents closing WebSocket connection on Firefox. See [related issue](https://bugzilla.mozilla.org/show_bug.cgi?id=858538) for more details.
Firefox. See
[related issue](https://bugzilla.mozilla.org/show_bug.cgi?id=858538) for more
details.
```js ```js
<DownloadButton href="example.zip">Download</DownloadButton> <DownloadButton href="example.zip">Download</DownloadButton>

View File

@ -6,14 +6,11 @@
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import Input from "./Input"; import { Input } from "./Input";
function EmailInput({ ...props }) { export const EmailInput = ({ ...props }) => <Input type="email" {...props} />;
return <Input type="email" {...props} />;
}
EmailInput.propTypes = { EmailInput.propTypes = {
/** Field label. */ /** Field label. */
@ -25,5 +22,3 @@ EmailInput.propTypes = {
/** Email value. */ /** Email value. */
value: PropTypes.string, value: PropTypes.string,
}; };
export default EmailInput;

View File

@ -1,19 +1,18 @@
Bootstrap component of email input with label with predefined sizes and Bootstrap component of email input with label with predefined sizes and structure for using in foris forms.
structure for using in foris forms. It use built-in browser email address It use built-in browser email address checking. It's only meaningful using inside `<form>`.
checking. It's only meaningful using inside `<form>`.
All additional `props` are passed to the `<input type="email">` HTML component. All additional `props` are passed to the `<input type="email">` HTML component.
```js ```js
import { useState } from "react"; import {useState} from 'react';
const [email, setEmail] = useState("Wrong email"); const [email, setEmail] = useState('Wrong email');
<form onSubmit={(e) => e.preventDefault()}> <form onSubmit={e=>e.preventDefault()}>
<EmailInput <EmailInput
value={email} value={email}
label="Some label" label="Some label"
helpText="Read the small text!" helpText="Read the small text!"
onChange={(event) => setEmail(event.target.value)} onChange={event =>setEmail(event.target.value)}
/> />
<button type="submit">Try to submit</button> <button type="submit">Try to submit</button>
</form>; </form>
``` ```

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
@ -8,8 +8,7 @@
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { Input } from "./Input";
import Input from "./Input";
FileInput.propTypes = { FileInput.propTypes = {
/** Field label. */ /** Field label. */
@ -24,7 +23,7 @@ FileInput.propTypes = {
multiple: PropTypes.bool, multiple: PropTypes.bool,
}; };
function FileInput({ ...props }) { export function FileInput({ ...props }) {
return ( return (
<Input <Input
type="file" type="file"
@ -35,5 +34,3 @@ function FileInput({ ...props }) {
/> />
); );
} }
export default FileInput;

View File

@ -1,10 +1,9 @@
Bootstrap component for file input. Includes label and has predefined sizes and Bootstrap component for file input. Includes label and has predefined sizes and structure for using in foris forms.
structure for using in foris forms.
All additional `props` are passed to the `<input type="file">` HTML component. All additional `props` are passed to the `<input type="file">` HTML component.
```js ```js
import { useState } from "react"; import { useState } from 'react';
const [files, setFiles] = useState([]); const [files, setFiles] = useState([]);
@ -16,33 +15,27 @@ const label = files.length === 1 ? files[0].name : "Choose file";
files={files} files={files}
label={label} label={label}
helpText="Will be uploaded" helpText="Will be uploaded"
onChange={(event) => setFiles(event.target.files)} onChange={event=>setFiles(event.target.files)}
/> />
</form>; </form>
``` ```
### FileInput with multiple files ### FileInput with multiple files
```js ```js
import { useState } from "react"; import { useState } from 'react';
const [files, setFiles] = useState([]); const [files, setFiles] = useState([]);
// Note that files is not an array but FileList. // Note that files is not an array but FileList.
const label = const label = files.length > 0 ? Array.from(files).map(file=>file.name).join(", ") : "Choose files";
files.length > 0
? Array.from(files)
.map((file) => file.name)
.join(", ")
: "Choose files";
<form className="col"> <form className="col">
<FileInput <FileInput
files={files} files={files}
label={label} label={label}
helpText="Will be uploaded" helpText="Will be uploaded"
onChange={(event) => setFiles(event.target.files)} onChange={event=>setFiles(event.target.files)}
multiple multiple
/> />
</form>; </form>
``` ```

View File

@ -1,67 +1,13 @@
/* /*
* Copyright (C) 2019-2022 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React, { forwardRef } from "react"; import React from "react";
import PropTypes from "prop-types";
import { useUID } from "react-uid"; import { useUID } from "react-uid";
import PropTypes from "prop-types";
/** Base bootstrap input component. */
const Input = forwardRef(
(
{
type,
label,
helpText,
error,
className,
children,
labelClassName,
groupClassName,
...props
},
ref
) => {
const uid = useUID();
const inputClassName = `${className || ""} ${
error ? "is-invalid" : ""
}`.trim();
return (
<div className="mb-3">
<label
className={`form-label ${labelClassName || ""}`.trim()}
htmlFor={uid}
>
{label}
</label>
<div className={`input-group ${groupClassName || ""}`.trim()}>
<input
className={`form-control ${inputClassName}`.trim()}
type={type}
id={uid}
ref={ref}
{...props}
/>
{children}
</div>
{error && <div className="invalid-feedback">{error}</div>}
{helpText && (
<div className="form-text">
<small>{helpText}</small>
</div>
)}
</div>
);
}
);
Input.displayName = "Input";
Input.propTypes = { Input.propTypes = {
type: PropTypes.string.isRequired, type: PropTypes.string.isRequired,
@ -77,4 +23,27 @@ Input.propTypes = {
groupClassName: PropTypes.string, groupClassName: PropTypes.string,
}; };
export default Input; /** Base bootstrap input component. */
export function Input({
type, label, helpText, error, className, children, labelClassName, groupClassName, ...props
}) {
const uid = useUID();
const inputClassName = `form-control ${className || ""} ${(error ? "is-invalid" : "")}`.trim();
return (
<div className="form-group">
<label className={labelClassName} htmlFor={uid}>{label}</label>
<div className={`input-group ${groupClassName || ""}`.trim()}>
<input
className={inputClassName}
type={type}
id={uid}
{...props}
/>
{children}
</div>
{error ? <div className="invalid-feedback">{error}</div> : null}
{helpText ? <small className="form-text text-muted">{helpText}</small> : null}
</div>
);
}

View File

@ -10,6 +10,6 @@
.modal.show { .modal.show {
display: block; display: block;
animation-name: modalFade; animation-name: modalFade;
animation-duration: 0.3s; animation-duration: .3s;
background: rgba(0, 0, 0, 0.2); background: rgba(0, 0, 0, 0.2);
} }

View File

@ -1,16 +1,15 @@
/* /*
* Copyright (C) 2020-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React, { useRef, useEffect } from "react"; import React, { useRef } from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { Portal } from "../utils/Portal";
import { useClickOutside } from "../utils/hooks"; import { useClickOutside } from "../utils/hooks";
import Portal from "../utils/Portal";
import "./Modal.css"; import "./Modal.css";
Modal.propTypes = { Modal.propTypes = {
@ -19,7 +18,6 @@ Modal.propTypes = {
/** Callback to manage modal visibility */ /** Callback to manage modal visibility */
setShown: PropTypes.func.isRequired, setShown: PropTypes.func.isRequired,
scrollable: PropTypes.bool, scrollable: PropTypes.bool,
size: PropTypes.string,
/** Modal content use following: `ModalHeader`, `ModalBody`, `ModalFooter` */ /** Modal content use following: `ModalHeader`, `ModalBody`, `ModalFooter` */
children: PropTypes.oneOfType([ children: PropTypes.oneOfType([
@ -28,54 +26,24 @@ Modal.propTypes = {
]).isRequired, ]).isRequired,
}; };
export function Modal({ shown, setShown, scrollable, size, children }) { export function Modal({
shown, setShown, scrollable, children,
}) {
const dialogRef = useRef(); const dialogRef = useRef();
let modalSize = "modal-";
useClickOutside(dialogRef, () => setShown(false)); useClickOutside(dialogRef, () => setShown(false));
useEffect(() => {
const handleEsc = (event) => {
if (event.keyCode === 27) {
setShown(false);
}
};
window.addEventListener("keydown", handleEsc);
return () => {
window.removeEventListener("keydown", handleEsc);
};
}, [setShown]);
switch (size) {
case "sm":
modalSize += "sm";
break;
case "lg":
modalSize += "lg";
break;
case "xl":
modalSize += "xl";
break;
default:
modalSize = "";
break;
}
return ( return (
<Portal containerId="modal-container"> <Portal containerId="modal-container">
<div <div className={`modal fade ${shown ? "show" : ""}`} role="dialog">
className={`modal fade ${shown ? "show" : ""}`.trim()}
role="dialog"
>
<div <div
ref={dialogRef} ref={dialogRef}
className={`${modalSize.trim()} modal-dialog modal-dialog-centered ${ className={`modal-dialog modal-dialog-centered${scrollable ? " modal-dialog-scrollable" : ""}`}
scrollable ? "modal-dialog-scrollable" : ""
}`.trim()}
role="document" role="document"
> >
<div className="modal-content">{children}</div> <div className="modal-content">
{children}
</div>
</div> </div>
</div> </div>
</Portal> </Portal>
@ -91,12 +59,9 @@ export function ModalHeader({ setShown, title }) {
return ( return (
<div className="modal-header"> <div className="modal-header">
<h5 className="modal-title">{title}</h5> <h5 className="modal-title">{title}</h5>
<button <button type="button" className="close" onClick={() => setShown(false)}>
type="button" <span aria-hidden="true">&times;</span>
className="btn-close" </button>
onClick={() => setShown(false)}
aria-label={_("Close")}
/>
</div> </div>
); );
} }
@ -120,5 +85,9 @@ ModalFooter.propTypes = {
}; };
export function ModalFooter({ children }) { export function ModalFooter({ children }) {
return <div className="modal-footer">{children}</div>; return (
<div className="modal-footer">
{children}
</div>
);
} }

View File

@ -1,47 +1,31 @@
Bootstrap modal component. Bootstrap modal component.
It's required to have an element `<div id={"modal-container"}/>` somewhere on it's required to have an element `<div id={"modal-container"}/>` somewhere on the page since modals are rendered in portals.
the page since modals are rendered in portals.
Modals also have three optional sizes, which can be defined through the `size`
prop:
- small - `sm`
- large - `lg`
- extra-large - `xl`
For more details please visit Bootstrap
<a href="https://getbootstrap.com/docs/4.5/components/modal/#optional-sizes" target="_blank">
documentation</a>.
```js ```js
<div id="modal-container" /> <div id="modal-container"/>
``` ```
```js ```js
import { ModalHeader, ModalBody, ModalFooter } from "./Modal"; import {ModalHeader, ModalBody, ModalFooter} from './Modal';
import { useState } from "react"; import {useState} from 'react';
const [shown, setShown] = useState(false); const [shown, setShown] = useState(false);
<> <>
<Modal setShown={setShown} shown={shown} size="sm"> <Modal setShown={setShown} shown={shown}>
<ModalHeader setShown={setShown} title="Warning!" /> <ModalHeader setShown={setShown} title='Warning!'/>
<ModalBody> <ModalBody><p>Bla bla bla...</p></ModalBody>
<p>Bla bla bla...</p>
</ModalBody>
<ModalFooter> <ModalFooter>
<button <button
className="btn btn-secondary" className='btn btn-secondary'
onClick={() => setShown(false)} onClick={() => setShown(false)}
> >Skip it</button>
Skip it
</button>
</ModalFooter> </ModalFooter>
</Modal> </Modal>
<button className="btn btn-secondary" onClick={() => setShown(true)}> <button className='btn btn-secondary' onClick={()=>setShown(true)}>
Show modal Show modal
</button> </button>
</>; </>
``` ```

View File

@ -4,7 +4,7 @@ input[type="number"] {
appearance: textfield; appearance: textfield;
} }
input[type="number"]::-webkit-inner-spin-button, input[type=number]::-webkit-inner-spin-button,
input[type="number"]::-webkit-outer-spin-button { input[type=number]::-webkit-outer-spin-button {
-webkit-appearance: none; -webkit-appearance: none;
} }

View File

@ -1,18 +1,15 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import { faMinus, faPlus } from "@fortawesome/free-solid-svg-icons";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import Input from "./Input";
import { useConditionalTimeout } from "../utils/hooks"; import { useConditionalTimeout } from "../utils/hooks";
import { Input } from "./Input";
import "./NumberInput.css"; import "./NumberInput.css";
NumberInput.propTypes = { NumberInput.propTypes = {
@ -23,10 +20,13 @@ NumberInput.propTypes = {
/** Help text message. */ /** Help text message. */
helpText: PropTypes.string, helpText: PropTypes.string,
/** Number value. */ /** Number value. */
value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]), value: PropTypes.oneOfType([
PropTypes.string,
PropTypes.number,
]),
/** Function called when value changes. */ /** Function called when value changes. */
onChange: PropTypes.func.isRequired, onChange: PropTypes.func.isRequired,
/** Additional description displayed to the right of input value. */ /** Additional description dispaled to the right of input value. */
inlineText: PropTypes.string, inlineText: PropTypes.string,
}; };
@ -34,27 +34,20 @@ NumberInput.defaultProps = {
value: 0, value: 0,
}; };
function NumberInput({ onChange, inlineText, value, ...props }) { export function NumberInput({
onChange, inlineText, value, ...props
}) {
function updateValue(initialValue, difference) { function updateValue(initialValue, difference) {
onChange({ target: { value: initialValue + difference } }); onChange({ target: { value: initialValue + difference } });
} }
const enableIncrease = useConditionalTimeout( const enableIncrease = useConditionalTimeout({ callback: updateValue }, value, 1);
{ callback: updateValue }, const enableDecrease = useConditionalTimeout({ callback: updateValue }, value, -1);
value,
1
);
const enableDecrease = useConditionalTimeout(
{ callback: updateValue },
value,
-1
);
return ( return (
<Input type="number" onChange={onChange} value={value} {...props}> <Input type="number" onChange={onChange} value={value} {...props}>
{inlineText && ( <div className="input-group-append">
<span className="input-group-text">{inlineText}</span> {inlineText && <p className="input-group-text">{inlineText}</p>}
)}
<button <button
type="button" type="button"
className="btn btn-outline-secondary" className="btn btn-outline-secondary"
@ -62,7 +55,7 @@ function NumberInput({ onChange, inlineText, value, ...props }) {
onMouseUp={() => enableIncrease(false)} onMouseUp={() => enableIncrease(false)}
aria-label="Increase" aria-label="Increase"
> >
<FontAwesomeIcon icon={faPlus} /> <i className="fas fa-plus" />
</button> </button>
<button <button
type="button" type="button"
@ -71,10 +64,9 @@ function NumberInput({ onChange, inlineText, value, ...props }) {
onMouseUp={() => enableDecrease(false)} onMouseUp={() => enableDecrease(false)}
aria-label="Decrease" aria-label="Decrease"
> >
<FontAwesomeIcon icon={faMinus} /> <i className="fas fa-minus" />
</button> </button>
</div>
</Input> </Input>
); );
} }
export default NumberInput;

View File

@ -1,18 +1,17 @@
Bootstrap component of number input with label with predefined sizes and Bootstrap component of number input with label with predefined sizes and structure for using in foris forms.
structure for using in foris forms.
All additional `props` are passed to the `<input type="number">` HTML component. All additional `props` are passed to the `<input type="number">` HTML component.
```js ```js
import { useState } from "react"; import {useState} from 'react';
const [value, setValue] = useState(42); const [value, setValue] = useState(42);
<NumberInput <NumberInput
value={value} value={value}
label="Some number" label="Some number"
helpText="Read the small text!" helpText="Read the small text!"
min="33" min='33'
max="54" max='54'
onChange={(event) => setValue(event.target.value)} onChange={event =>setValue(event.target.value)}
/>; />
``` ```

View File

@ -1,17 +1,14 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React, { useState } from "react"; import React, { useState } from "react";
import { faEye, faEyeSlash } from "@fortawesome/free-solid-svg-icons";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import Input from "./Input"; import { Input } from "./Input";
PasswordInput.propTypes = { PasswordInput.propTypes = {
/** Field label. */ /** Field label. */
@ -24,20 +21,19 @@ PasswordInput.propTypes = {
helpText: PropTypes.string, helpText: PropTypes.string,
/** Use show/hide password button. */ /** Use show/hide password button. */
withEye: PropTypes.bool, withEye: PropTypes.bool,
/** Use new-password in autocomplete attribute. */
newPass: PropTypes.bool,
}; };
function PasswordInput({ withEye, newPass, ...props }) { export function PasswordInput({ withEye, ...props }) {
const [isHidden, setHidden] = useState(true); const [isHidden, setHidden] = useState(true);
return ( return (
<Input <Input
type={withEye && !isHidden ? "text" : "password"} type={withEye && !isHidden ? "text" : "password"}
autoComplete={newPass ? "new-password" : "current-password"} autoComplete={isHidden ? "new-password" : null}
{...props} {...props}
> >
{withEye && ( {withEye
? (
<div className="input-group-append">
<button <button
type="button" type="button"
className="input-group-text" className="input-group-text"
@ -46,15 +42,11 @@ function PasswordInput({ withEye, newPass, ...props }) {
setHidden((shouldBeHidden) => !shouldBeHidden); setHidden((shouldBeHidden) => !shouldBeHidden);
}} }}
> >
<FontAwesomeIcon <i className={`fa ${isHidden ? "fa-eye" : "fa-eye-slash"}`} />
icon={isHidden ? faEye : faEyeSlash}
style={{ width: "1.25rem" }}
className="text-dark"
/>
</button> </button>
)} </div>
)
: null}
</Input> </Input>
); );
} }
export default PasswordInput;

View File

@ -1,18 +1,17 @@
Password Bootstrap component input with label and predefined sizes and structure Password Bootstrap component input with label and predefined sizes and structure for using in foris forms.
for using in foris forms. Can be used with "eye" button, see example. Can be used with "eye" button, see example.
All additional `props` are passed to the `<input type="password">` HTML All additional `props` are passed to the `<input type="password">` HTML component.
component.
```js ```js
import { useState } from "react"; import {useState} from 'react';
const [value, setValue] = useState("secret"); const [value, setValue] = useState('secret');
<PasswordInput <PasswordInput
withEye withEye
value={value} value={value}
label="Some password" label="Some password"
helpText="Read the small text!" helpText="Read the small text!"
onChange={(event) => setValue(event.target.value)} onChange={event =>setValue(event.target.value)}
/>; />
``` ```

View File

@ -1,12 +1,11 @@
/* /*
* Copyright (C) 2020-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { useUID } from "react-uid"; import { useUID } from "react-uid";
@ -16,9 +15,8 @@ RadioSet.propTypes = {
/** RadioSet label . */ /** RadioSet label . */
label: PropTypes.string, label: PropTypes.string,
/** Choices . */ /** Choices . */
choices: PropTypes.arrayOf( choices: PropTypes.arrayOf(PropTypes.shape({
PropTypes.shape({ /** Choice lable . */
/** Choice label . */
label: PropTypes.oneOfType([ label: PropTypes.oneOfType([
PropTypes.string, PropTypes.string,
PropTypes.element, PropTypes.element,
@ -26,18 +24,17 @@ RadioSet.propTypes = {
PropTypes.arrayOf(PropTypes.node), PropTypes.arrayOf(PropTypes.node),
]).isRequired, ]).isRequired,
/** Choice value . */ /** Choice value . */
value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]) value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired,
.isRequired, })).isRequired,
})
).isRequired,
/** Initial value . */ /** Initial value . */
value: PropTypes.string, value: PropTypes.string,
/** Help text message . */ /** Help text message . */
helpText: PropTypes.string, helpText: PropTypes.string,
inline: PropTypes.bool,
}; };
function RadioSet({ name, label, choices, value, helpText, inline, ...props }) { export function RadioSet({
name, label, choices, value, helpText, ...props
}) {
const uid = useUID(); const uid = useUID();
const radios = choices.map((choice, key) => { const radios = choices.map((choice, key) => {
const id = `${name}-${key}`; const id = `${name}-${key}`;
@ -50,25 +47,17 @@ function RadioSet({ name, label, choices, value, helpText, inline, ...props }) {
value={choice.value} value={choice.value}
helpText={choice.helpText} helpText={choice.helpText}
checked={choice.value === value} checked={choice.value === value}
inline={inline}
{...props} {...props}
/> />
); );
}); });
return ( return (
<div className="mb-3"> <div className="form-group">
{label && ( {label && <label htmlFor={uid} className="d-block">{label}</label>}
<label htmlFor={uid} className="d-block">
{label}
</label>
)}
{radios} {radios}
{helpText && ( {helpText && <small className="form-text text-muted">{helpText}</small>}
<div className="form-text">
<small>{helpText}</small>
</div>
)}
</div> </div>
); );
} }
@ -81,32 +70,25 @@ Radio.propTypes = {
PropTypes.arrayOf(PropTypes.node), PropTypes.arrayOf(PropTypes.node),
]).isRequired, ]).isRequired,
id: PropTypes.string.isRequired, id: PropTypes.string.isRequired,
inline: PropTypes.bool,
helpText: PropTypes.string, helpText: PropTypes.string,
className: PropTypes.string,
}; };
export function Radio({ label, id, helpText, inline, className, ...props }) { export function Radio({
label, id, helpText, ...props
}) {
return ( return (
<div <>
className={`${className || "mb-3"} ${inline ? "form-check form-check-inline" : ""}`.trim()} <div className={`custom-control custom-radio ${!helpText ? "custom-control-inline" : ""}`.trim()}>
>
<input <input
id={id} id={id}
className="form-check-input me-2" className="custom-control-input"
type="radio" type="radio"
{...props} {...props}
/> />
<label className="form-check-label" htmlFor={id}> <label className="custom-control-label" htmlFor={id}>{label}</label>
{label} {helpText && <small className="form-text text-muted mt-0 mb-3">{helpText}</small>}
{helpText && (
<div className="form-text">
<small>{helpText}</small>
</div>
)}
</label>
</div> </div>
</>
); );
} }
export default RadioSet;

View File

@ -1,16 +1,15 @@
Set of radio Bootstrap component input with label and predefined sizes and Set of radio Bootstrap component input with label and predefined sizes and structure for using in foris forms.
structure for using in foris forms.
All additional `props` are passed to the `<input type="number">` HTML component. All additional `props` are passed to the `<input type="number">` HTML component.
Unless `helpText` is set for one of the options they are displayed inline. Unless `helpText` is set for one of the options they are displayed inline.
```js ```js
import { useState } from "react"; import {useState} from 'react';
const CHOICES = [ const CHOICES=[
{ value: "one", label: "1" }, {value:'one',label:'1'},
{ value: "two", label: "2" }, {value:'two',label:'2'},
{ value: "three", label: "3" }, {value:'three',label:'3'},
]; ];
const [value, setValue] = useState(CHOICES[0].value); const [value, setValue] = useState(CHOICES[0].value);
@ -18,10 +17,10 @@ const [value, setValue] = useState(CHOICES[0].value);
{/*Yeah, it gets event, not value!*/} {/*Yeah, it gets event, not value!*/}
<RadioSet <RadioSet
value={value} value={value}
name="some-radio" name='some-radio'
choices={CHOICES} choices={CHOICES}
onChange={(event) => setValue(event.target.value)} onChange={event =>setValue(event.target.value)}
/> />
<p>Selected value: {value}</p> <p>Selected value: {value}</p>
</>; </>
``` ```

View File

@ -1,12 +1,11 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { useUID } from "react-uid"; import { useUID } from "react-uid";
@ -16,35 +15,35 @@ Select.propTypes = {
/** Choices if form of {value : "Label",...}. */ /** Choices if form of {value : "Label",...}. */
choices: PropTypes.object.isRequired, choices: PropTypes.object.isRequired,
/** Current value. */ /** Current value. */
value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired, value: PropTypes.oneOfType([
PropTypes.string,
PropTypes.number,
]).isRequired,
/** Help text message. */ /** Help text message. */
helpText: PropTypes.string, helpText: PropTypes.string,
}; };
function Select({ label, choices, helpText, ...props }) { export function Select({
label, choices, helpText, ...props
}) {
const uid = useUID(); const uid = useUID();
const options = Object.keys(choices).map((choice) => ( const options = Object.keys(choices).sort(
<option key={choice} value={choice}> (a, b) => a - b || a.toString().localeCompare(b.toString()),
{choices[choice]} ).map(
</option> (key) => <option key={key} value={key}>{choices[key]}</option>,
)); );
return ( return (
<div className="mb-3"> <div className="form-group">
<label className="form-label" htmlFor={uid}> <label htmlFor={uid}>{label}</label>
{label} <select
</label> className="custom-select"
<select className="form-select" id={uid} {...props}> id={uid}
{...props}
>
{options} {options}
</select> </select>
{helpText && ( {helpText ? <small className="form-text text-muted">{helpText}</small> : null}
<div className="form-text">
<small>{helpText}</small>
</div>
)}
</div> </div>
); );
} }
export default Select;

View File

@ -1,14 +1,13 @@
Select with options Bootstrap component input with label and predefined sizes Select with options Bootstrap component input with label and predefined sizes and structure for using in foris forms.
and structure for using in foris forms.
All additional `props` are passed to the `<select>` HTML component. All additional `props` are passed to the `<select>` HTML component.
```js ```js
import { useState } from "react"; import {useState} from 'react';
const CHOICES = { const CHOICES={
apple: "Apple", apple:'Apple',
banana: "Banana", banana:'Banana',
peach: "Peach", peach:'Peach',
}; };
const [value, setValue] = useState(Object.keys(CHOICES)[0]); const [value, setValue] = useState(Object.keys(CHOICES)[0]);
@ -18,9 +17,9 @@ const [value, setValue] = useState(Object.keys(CHOICES)[0]);
label="Fruit" label="Fruit"
value={value} value={value}
choices={CHOICES} choices={CHOICES}
onChange={(event) => setValue(event.target.value)} onChange={event=>setValue(event.target.value)}
/> />
<p>Selected choice label: {CHOICES[value]}</p> <p>Selected choice label: {CHOICES[value]}</p>
<p>Selected choice value: {value}</p> <p>Selected choice value: {value}</p>
</>; </>
``` ```

View File

@ -1,11 +1,3 @@
.spinner-fs-wrapper {
position: fixed;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);
z-index: 1101; /* increase z-index by 1 to ensure it's on top of spinner-fs-background */
}
.spinner-wrapper .spinner-border { .spinner-wrapper .spinner-border {
width: 4rem; width: 4rem;
height: 4rem; height: 4rem;
@ -13,10 +5,12 @@
} }
.spinner-fs-background { .spinner-fs-background {
background-color: rgba(2, 2, 2, 0.5); background-color: rgba(2, 2, 2, .5);
color: rgb(230, 230, 230); color: rgb(230, 230, 230);
width: 100vw; position: fixed;
height: 100vh; width: 100%;
height: 100%;
top: 0;
display: flex; display: flex;
align-items: center; align-items: center;
@ -37,7 +31,3 @@
.spinner-fs-wrapper .spinner-text { .spinner-fs-wrapper .spinner-text {
margin: 1rem; margin: 1rem;
} }
.spinner-border-sm {
min-width: 16px;
}

View File

@ -6,7 +6,6 @@
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import "./Spinner.css"; import "./Spinner.css";
@ -17,7 +16,7 @@ Spinner.propTypes = {
PropTypes.arrayOf(PropTypes.node), PropTypes.arrayOf(PropTypes.node),
PropTypes.node, PropTypes.node,
]), ]),
/** Render component with full-screen mode (using appropriate `.css` styles) */ /** Render component with full-screen mode (using apropriate `.css` styles) */
fullScreen: PropTypes.bool.isRequired, fullScreen: PropTypes.bool.isRequired,
className: PropTypes.string, className: PropTypes.string,
}; };
@ -26,12 +25,12 @@ Spinner.defaultProps = {
fullScreen: false, fullScreen: false,
}; };
export function Spinner({ fullScreen, children, className }) { export function Spinner({
fullScreen, children, className,
}) {
if (!fullScreen) { if (!fullScreen) {
return ( return (
<div <div className={`spinner-wrapper ${className || "my-3 text-center"}`}>
className={`spinner-wrapper ${className || "my-3 text-center"}`}
>
<SpinnerElement>{children}</SpinnerElement> <SpinnerElement>{children}</SpinnerElement>
</div> </div>
); );
@ -62,9 +61,7 @@ export function SpinnerElement({ small, className, children }) {
return ( return (
<> <>
<div <div
className={`spinner-border ${ className={`spinner-border ${small ? "spinner-border-sm" : ""} ${className || ""}`.trim()}
small ? "spinner-border-sm" : ""
} ${className || ""}`.trim()}
role="status" role="status"
> >
<span className="sr-only" /> <span className="sr-only" />

View File

@ -1,53 +0,0 @@
/*
* Copyright (c) 2020-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/)
*
* This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information.
*/
import React from "react";
import PropTypes from "prop-types";
import { useUID } from "react-uid";
Switch.propTypes = {
label: PropTypes.oneOfType([
PropTypes.string,
PropTypes.element,
PropTypes.node,
PropTypes.arrayOf(PropTypes.node),
]).isRequired,
helpText: PropTypes.string,
switchHeading: PropTypes.bool,
className: PropTypes.string,
};
function Switch({ label, helpText, switchHeading, className, ...props }) {
const uid = useUID();
return (
<div
className={`form-check form-switch ${className || "mb-3"} ${
switchHeading ? "d-flex align-items-center" : ""
}`.trim()}
>
<input
type="checkbox"
className={`form-check-input ${switchHeading ? "me-2" : ""}`.trim()}
role="switch"
id={uid}
{...props}
/>
<label className="form-check-label" htmlFor={uid}>
{label}
</label>
{helpText && (
<div className="form-text">
<small>{helpText}</small>
</div>
)}
</div>
);
}
export default Switch;

View File

@ -1,5 +0,0 @@
Switch example:
```js
<Switch label="Enable Switch" helpText="Toggle that switch!" />
```

View File

@ -1,19 +1,16 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import Input from "./Input"; import { Input } from "./Input";
function TextInput({ ...props }) { export const TextInput = ({ ...props }) => <Input type="text" {...props} />;
return <Input type="text" {...props} />;
}
TextInput.propTypes = { TextInput.propTypes = {
/** Field label. */ /** Field label. */
@ -23,5 +20,3 @@ TextInput.propTypes = {
/** Help text message. */ /** Help text message. */
helpText: PropTypes.string, helpText: PropTypes.string,
}; };
export default TextInput;

View File

@ -1,16 +1,15 @@
Text Bootstrap component input with label and predefined sizes and structure for Text Bootstrap component input with label and predefined sizes and structure for using in foris forms.
using in foris forms.
All additional `props` are passed to the `<input type="text">` HTML component. All additional `props` are passed to the `<input type="text">` HTML component.
```js ```js
import { useState } from "react"; import {useState} from 'react';
const [value, setValue] = useState("Bla bla"); const [value, setValue] = useState('Bla bla');
<TextInput <TextInput
value={value} value={value}
label="Some text" label="Some text"
helpText="Read the small text!" helpText="Read the small text!"
onChange={(event) => setValue(event.target.value)} onChange={event =>setValue(event.target.value)}
/>; />
``` ```

View File

@ -9,23 +9,24 @@ import React from "react";
import { render } from "customTestRender"; import { render } from "customTestRender";
import Button from "../Button"; import { Button } from "../Button";
describe("<Button />", () => { describe("<Button />", () => {
it("Render button correctly", () => { it("Render button correctly", () => {
const { container } = render(<Button>Test Button</Button>); const { container } = render(<Button>Test Button</Button>);
expect(container.firstChild).toMatchSnapshot(); expect(container.firstChild)
.toMatchSnapshot();
}); });
it("Render button with custom classes", () => { it("Render button with custom classes", () => {
const { container } = render( const { container } = render(<Button className="one two three">Test Button</Button>);
<Button className="one two three">Test Button</Button> expect(container.firstChild)
); .toMatchSnapshot();
expect(container.firstChild).toMatchSnapshot();
}); });
it("Render button with spinner", () => { it("Render button with spinner", () => {
const { container } = render(<Button loading>Test Button</Button>); const { container } = render(<Button loading>Test Button</Button>);
expect(container.firstChild).toMatchSnapshot(); expect(container.firstChild)
.toMatchSnapshot();
}); });
}); });

View File

@ -9,7 +9,7 @@ import React from "react";
import { render } from "customTestRender"; import { render } from "customTestRender";
import CheckBox from "../CheckBox"; import { CheckBox } from "../CheckBox";
describe("<Checkbox/>", () => { describe("<Checkbox/>", () => {
it("Render checkbox", () => { it("Render checkbox", () => {
@ -18,16 +18,22 @@ describe("<Checkbox/>", () => {
label="Test label" label="Test label"
checked checked
helpText="Some help text" helpText="Some help text"
onChange={() => {}} onChange={() => {
/> }}
/>,
); );
expect(container.firstChild).toMatchSnapshot(); expect(container.firstChild)
.toMatchSnapshot();
}); });
it("Render uncheked checkbox", () => { it("Render uncheked checkbox", () => {
const { container } = render( const { container } = render(
<CheckBox label="Test label" helpText="Some help text" /> <CheckBox
label="Test label"
helpText="Some help text"
/>,
); );
expect(container.firstChild).toMatchSnapshot(); expect(container.firstChild)
.toMatchSnapshot();
}); });
}); });

View File

@ -9,15 +9,11 @@ import React from "react";
import { render } from "customTestRender"; import { render } from "customTestRender";
import DownloadButton from "../DownloadButton"; import { DownloadButton } from "../DownloadButton";
describe("<DownloadButton />", () => { describe("<DownloadButton />", () => {
it("should have download attribute", () => { it("should have download attribute", () => {
const { container } = render( const { container } = render(<DownloadButton href="http://example.com">Test Button</DownloadButton>);
<DownloadButton href="http://example.com">
Test Button
</DownloadButton>
);
expect(container.firstChild.getAttribute("download")).not.toBeNull(); expect(container.firstChild.getAttribute("download")).not.toBeNull();
}); });
}); });

View File

@ -7,9 +7,11 @@
import React from "react"; import React from "react";
import { render, fireEvent, getByLabelText, wait } from "customTestRender"; import {
render, fireEvent, getByLabelText, wait,
} from "customTestRender";
import NumberInput from "../NumberInput"; import { NumberInput } from "../NumberInput";
describe("<NumberInput/>", () => { describe("<NumberInput/>", () => {
const onChangeMock = jest.fn(); const onChangeMock = jest.fn();
@ -22,7 +24,7 @@ describe("<NumberInput/>", () => {
helpText="Some help text" helpText="Some help text"
value={1} value={1}
onChange={onChangeMock} onChange={onChangeMock}
/> />,
); );
componentContainer = container; componentContainer = container;
}); });
@ -34,16 +36,12 @@ describe("<NumberInput/>", () => {
it("Increase number with button", async () => { it("Increase number with button", async () => {
const increaseButton = getByLabelText(componentContainer, "Increase"); const increaseButton = getByLabelText(componentContainer, "Increase");
fireEvent.mouseDown(increaseButton); fireEvent.mouseDown(increaseButton);
await wait(() => await wait(() => expect(onChangeMock).toHaveBeenCalledWith({ target: { value: 2 } }));
expect(onChangeMock).toHaveBeenCalledWith({ target: { value: 2 } })
);
}); });
it("Decrease number with button", async () => { it("Decrease number with button", async () => {
const decreaseButton = getByLabelText(componentContainer, "Decrease"); const decreaseButton = getByLabelText(componentContainer, "Decrease");
fireEvent.mouseDown(decreaseButton); fireEvent.mouseDown(decreaseButton);
await wait(() => await wait(() => expect(onChangeMock).toHaveBeenCalledWith({ target: { value: 0 } }));
expect(onChangeMock).toHaveBeenCalledWith({ target: { value: 0 } })
);
}); });
}); });

View File

@ -9,7 +9,7 @@ import React from "react";
import { render } from "customTestRender"; import { render } from "customTestRender";
import PasswordInput from "../PasswordInput"; import { PasswordInput } from "../PasswordInput";
describe("<PasswordInput/>", () => { describe("<PasswordInput/>", () => {
it("Render password input", () => { it("Render password input", () => {
@ -18,9 +18,11 @@ describe("<PasswordInput/>", () => {
label="Test label" label="Test label"
helpText="Some help text" helpText="Some help text"
value="Some password" value="Some password"
onChange={() => {}} onChange={() => {
/> }}
/>,
); );
expect(container.firstChild).toMatchSnapshot(); expect(container.firstChild)
.toMatchSnapshot();
}); });
}); });

View File

@ -9,7 +9,7 @@ import React from "react";
import { render } from "customTestRender"; import { render } from "customTestRender";
import RadioSet from "../RadioSet"; import { RadioSet } from "../RadioSet";
const TEST_CHOICES = [ const TEST_CHOICES = [
{ {
@ -35,9 +35,11 @@ describe("<RadioSet/>", () => {
value="value" value="value"
choices={TEST_CHOICES} choices={TEST_CHOICES}
helpText="Some help text" helpText="Some help text"
onChange={() => {}} onChange={() => {
/> }}
/>,
); );
expect(container.firstChild).toMatchSnapshot(); expect(container.firstChild)
.toMatchSnapshot();
}); });
}); });

View File

@ -8,13 +8,10 @@
import React from "react"; import React from "react";
import { import {
fireEvent, fireEvent, getByDisplayValue, getByText, render,
getByDisplayValue,
getByText,
render,
} from "customTestRender"; } from "customTestRender";
import Select from "../Select"; import { Select } from "../Select";
const TEST_CHOICES = { const TEST_CHOICES = {
1: "one", 1: "one",
@ -32,24 +29,29 @@ describe("<Select/>", () => {
value="1" value="1"
choices={TEST_CHOICES} choices={TEST_CHOICES}
helpText="Help text" helpText="Help text"
onChange={onChangeHandler} onChange={onChangeHandler}
/> />,
); );
selectContainer = container; selectContainer = container;
}); });
it("Test with snapshot.", () => { it("Test with snapshot.", () => {
expect(selectContainer).toMatchSnapshot(); expect(selectContainer)
.toMatchSnapshot();
}); });
it("Test onChange handling.", () => { it("Test onChange handling.", () => {
const select = getByDisplayValue(selectContainer, "one"); const select = getByDisplayValue(selectContainer, "one");
expect(select.value).toBe("1"); expect(select.value)
.toBe("1");
fireEvent.change(select, { target: { value: "2" } }); fireEvent.change(select, { target: { value: "2" } });
const option = getByText(selectContainer, "two"); const option = getByText(selectContainer, "two");
expect(onChangeHandler).toBeCalled(); expect(onChangeHandler)
.toBeCalled();
expect(option.value).toBe("2"); expect(option.value)
.toBe("2");
}); });
}); });

View File

@ -1,33 +0,0 @@
/*
* Copyright (C) 2020 CZ.NIC z.s.p.o. (http://www.nic.cz/)
*
* This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information.
*/
import React from "react";
import { render } from "customTestRender";
import Switch from "../Switch";
describe("<Switch/>", () => {
it("Render switch", () => {
const { container } = render(
<Switch
label="Test label"
checked
helpText="Some help text"
onChange={() => {}}
/>
);
expect(container.firstChild).toMatchSnapshot();
});
it("Render uncheked switch", () => {
const { container } = render(
<Switch label="Test label" helpText="Some help text" />
);
expect(container.firstChild).toMatchSnapshot();
});
});

View File

@ -9,7 +9,7 @@ import React from "react";
import { render } from "customTestRender"; import { render } from "customTestRender";
import TextInput from "../TextInput"; import { TextInput } from "../TextInput";
describe("<TextInput/>", () => { describe("<TextInput/>", () => {
it("Render text input", () => { it("Render text input", () => {
@ -18,9 +18,11 @@ describe("<TextInput/>", () => {
label="Test label" label="Test label"
helpText="Some help text" helpText="Some help text"
value="Some text" value="Some text"
onChange={() => {}} onChange={() => {
/> }}
/>,
); );
expect(container.firstChild).toMatchSnapshot(); expect(container.firstChild)
.toMatchSnapshot();
}); });
}); });

View File

@ -2,38 +2,39 @@
exports[`<Button /> Render button correctly 1`] = ` exports[`<Button /> Render button correctly 1`] = `
<button <button
class="btn btn-primary d-inline-flex justify-content-center align-items-center" class="btn btn-primary "
type="button" type="button"
> >
<span>
Test Button Test Button
</span>
</button> </button>
`; `;
exports[`<Button /> Render button with custom classes 1`] = ` exports[`<Button /> Render button with custom classes 1`] = `
<button <button
class="btn one two three d-inline-flex justify-content-center align-items-center" class="btn one two three"
type="button" type="button"
> >
<span>
Test Button Test Button
</span>
</button> </button>
`; `;
exports[`<Button /> Render button with spinner 1`] = ` exports[`<Button /> Render button with spinner 1`] = `
<button <button
class="btn btn-primary d-inline-flex justify-content-center align-items-center" class="btn btn-primary "
type="button" type="button"
> >
<span <span
aria-hidden="true" aria-hidden="true"
class="spinner-border spinner-border-sm me-1" class="spinner-border spinner-border-sm"
role="status" role="status"
/> />
<span>
Test Button Test Button
</span>
</button> </button>
`; `;

View File

@ -2,51 +2,55 @@
exports[`<Checkbox/> Render checkbox 1`] = ` exports[`<Checkbox/> Render checkbox 1`] = `
<div <div
class="mb-3 form-check" class="form-group"
> >
<div
class="custom-control custom-checkbox "
>
<input <input
checked="" checked=""
class="form-check-input" class="custom-control-input"
id="1" id="1"
type="checkbox" type="checkbox"
/> />
<label <label
class="form-check-label" class="custom-control-label"
for="1" for="1"
> >
Test label Test label
</label> <small
<div class="form-text text-muted"
class="form-text"
> >
<small>
Some help text Some help text
</small> </small>
</label>
</div> </div>
</div> </div>
`; `;
exports[`<Checkbox/> Render uncheked checkbox 1`] = ` exports[`<Checkbox/> Render uncheked checkbox 1`] = `
<div <div
class="mb-3 form-check" class="form-group"
> >
<div
class="custom-control custom-checkbox "
>
<input <input
class="form-check-input" class="custom-control-input"
id="1" id="1"
type="checkbox" type="checkbox"
/> />
<label <label
class="form-check-label" class="custom-control-label"
for="1" for="1"
> >
Test label Test label
</label> <small
<div class="form-text text-muted"
class="form-text"
> >
<small>
Some help text Some help text
</small> </small>
</label>
</div> </div>
</div> </div>
`; `;

View File

@ -2,10 +2,9 @@
exports[`<NumberInput/> Render number input 1`] = ` exports[`<NumberInput/> Render number input 1`] = `
<div <div
class="mb-3" class="form-group"
> >
<label <label
class="form-label"
for="1" for="1"
> >
Test label Test label
@ -19,13 +18,16 @@ exports[`<NumberInput/> Render number input 1`] = `
type="number" type="number"
value="1" value="1"
/> />
<div
class="input-group-append"
>
<button <button
aria-label="Increase" aria-label="Increase"
class="btn btn-outline-secondary" class="btn btn-outline-secondary"
type="button" type="button"
> >
<i <i
class="fa" class="fas fa-plus"
/> />
</button> </button>
<button <button
@ -34,16 +36,15 @@ exports[`<NumberInput/> Render number input 1`] = `
type="button" type="button"
> >
<i <i
class="fa" class="fas fa-minus"
/> />
</button> </button>
</div> </div>
<div </div>
class="form-text" <small
class="form-text text-muted"
> >
<small>
Some help text Some help text
</small> </small>
</div>
</div> </div>
`; `;

View File

@ -2,10 +2,9 @@
exports[`<PasswordInput/> Render password input 1`] = ` exports[`<PasswordInput/> Render password input 1`] = `
<div <div
class="mb-3" class="form-group"
> >
<label <label
class="form-label"
for="1" for="1"
> >
Test label Test label
@ -14,19 +13,17 @@ exports[`<PasswordInput/> Render password input 1`] = `
class="input-group" class="input-group"
> >
<input <input
autocomplete="current-password" autocomplete="new-password"
class="form-control" class="form-control"
id="1" id="1"
type="password" type="password"
value="Some password" value="Some password"
/> />
</div> </div>
<div <small
class="form-text" class="form-text text-muted"
> >
<small>
Some help text Some help text
</small> </small>
</div>
</div> </div>
`; `;

View File

@ -2,7 +2,7 @@
exports[`<RadioSet/> Render radio set 1`] = ` exports[`<RadioSet/> Render radio set 1`] = `
<div <div
class="mb-3" class="form-group"
> >
<label <label
class="d-block" class="d-block"
@ -11,63 +11,61 @@ exports[`<RadioSet/> Render radio set 1`] = `
Radios set label Radios set label
</label> </label>
<div <div
class="mb-3" class="custom-control custom-radio custom-control-inline"
> >
<input <input
checked="" checked=""
class="form-check-input me-2" class="custom-control-input"
id="test_name-0" id="test_name-0"
name="test_name" name="test_name"
type="radio" type="radio"
value="value" value="value"
/> />
<label <label
class="form-check-label" class="custom-control-label"
for="test_name-0" for="test_name-0"
> >
label label
</label> </label>
</div> </div>
<div <div
class="mb-3" class="custom-control custom-radio custom-control-inline"
> >
<input <input
class="form-check-input me-2" class="custom-control-input"
id="test_name-1" id="test_name-1"
name="test_name" name="test_name"
type="radio" type="radio"
value="another value" value="another value"
/> />
<label <label
class="form-check-label" class="custom-control-label"
for="test_name-1" for="test_name-1"
> >
another label another label
</label> </label>
</div> </div>
<div <div
class="mb-3" class="custom-control custom-radio custom-control-inline"
> >
<input <input
class="form-check-input me-2" class="custom-control-input"
id="test_name-2" id="test_name-2"
name="test_name" name="test_name"
type="radio" type="radio"
value="another on value" value="another on value"
/> />
<label <label
class="form-check-label" class="custom-control-label"
for="test_name-2" for="test_name-2"
> >
another one label another one label
</label> </label>
</div> </div>
<div <small
class="form-text" class="form-text text-muted"
> >
<small>
Some help text Some help text
</small> </small>
</div>
</div> </div>
`; `;

View File

@ -3,16 +3,15 @@
exports[`<Select/> Test with snapshot. 1`] = ` exports[`<Select/> Test with snapshot. 1`] = `
<div> <div>
<div <div
class="mb-3" class="form-group"
> >
<label <label
class="form-label"
for="1" for="1"
> >
Test label Test label
</label> </label>
<select <select
class="form-select" class="custom-select"
id="1" id="1"
> >
<option <option
@ -31,13 +30,11 @@ exports[`<Select/> Test with snapshot. 1`] = `
three three
</option> </option>
</select> </select>
<div <small
class="form-text" class="form-text text-muted"
> >
<small>
Help text Help text
</small> </small>
</div> </div>
</div>
</div> </div>
`; `;

View File

@ -1,54 +0,0 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`<Switch/> Render switch 1`] = `
<div
class="form-check form-switch mb-3"
>
<input
checked=""
class="form-check-input"
id="1"
role="switch"
type="checkbox"
/>
<label
class="form-check-label"
for="1"
>
Test label
</label>
<div
class="form-text"
>
<small>
Some help text
</small>
</div>
</div>
`;
exports[`<Switch/> Render uncheked switch 1`] = `
<div
class="form-check form-switch mb-3"
>
<input
class="form-check-input"
id="1"
role="switch"
type="checkbox"
/>
<label
class="form-check-label"
for="1"
>
Test label
</label>
<div
class="form-text"
>
<small>
Some help text
</small>
</div>
</div>
`;

View File

@ -2,10 +2,9 @@
exports[`<TextInput/> Render text input 1`] = ` exports[`<TextInput/> Render text input 1`] = `
<div <div
class="mb-3" class="form-group"
> >
<label <label
class="form-label"
for="1" for="1"
> >
Test label Test label
@ -20,12 +19,10 @@ exports[`<TextInput/> Render text input 1`] = `
value="Some text" value="Some text"
/> />
</div> </div>
<div <small
class="form-text" class="form-text text-muted"
> >
<small>
Some help text Some help text
</small> </small>
</div>
</div> </div>
`; `;

View File

@ -1,12 +1,10 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
/** Bootstrap column size for form fields */ /** Bootstrap column size for form fields */
const formFieldsSize = "card p-4 col-sm-12 col-lg-12 p-0 mb-4"; // eslint-disable-next-line import/prefer-default-export
const buttonFormFieldsSize = "col-sm-12 col-lg-12 p-0 mb-3"; export const formFieldsSize = "col-sm-12 offset-lg-1 col-lg-10 p-0 mb-3";
export { formFieldsSize, buttonFormFieldsSize };

View File

@ -1,22 +1,28 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React, { useState, useEffect } from "react"; import React, { useState, useEffect } from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { useAPIPost } from "../api/hooks"; import { useAPIPost } from "../api/hooks";
import { API_STATE } from "../api/utils"; import { API_STATE } from "../api/utils";
import Button from "../bootstrap/Button";
import { Modal, ModalHeader, ModalBody, ModalFooter } from "../bootstrap/Modal";
import { useAlert } from "../context/alertContext/AlertContext";
import { ForisURLs } from "../utils/forisUrls"; import { ForisURLs } from "../utils/forisUrls";
function RebootButton(props) { import { Button } from "../bootstrap/Button";
import {
Modal, ModalHeader, ModalBody, ModalFooter,
} from "../bootstrap/Modal";
import { useAlert } from "../alertContext/AlertContext";
RebootButton.propTypes = {
forisFormSize: PropTypes.bool,
};
export function RebootButton(props) {
const [triggered, setTriggered] = useState(false); const [triggered, setTriggered] = useState(false);
const [modalShown, setModalShown] = useState(false); const [modalShown, setModalShown] = useState(false);
const [triggerRebootStatus, triggerReboot] = useAPIPost(ForisURLs.reboot); const [triggerRebootStatus, triggerReboot] = useAPIPost(ForisURLs.reboot);
@ -28,24 +34,21 @@ function RebootButton(props) {
} }
}); });
const rebootHandler = () => { function rebootHandler() {
setTriggered(true); setTriggered(true);
triggerReboot(); triggerReboot();
setModalShown(false); setModalShown(false);
}; }
return ( return (
<> <>
<RebootModal <RebootModal shown={modalShown} setShown={setModalShown} onReboot={rebootHandler} />
shown={modalShown}
setShown={setModalShown}
onReboot={rebootHandler}
/>
<Button <Button
className="btn-danger" className="btn-danger"
loading={triggered} loading={triggered}
disabled={triggered} disabled={triggered}
onClick={() => setModalShown(true)} onClick={() => setModalShown(true)}
{...props} {...props}
> >
{_("Reboot")} {_("Reboot")}
@ -63,18 +66,12 @@ RebootModal.propTypes = {
function RebootModal({ shown, setShown, onReboot }) { function RebootModal({ shown, setShown, onReboot }) {
return ( return (
<Modal shown={shown} setShown={setShown}> <Modal shown={shown} setShown={setShown}>
<ModalHeader setShown={setShown} title={_("Warning!")} /> <ModalHeader setShown={setShown} title={_("Reboot confirmation")} />
<ModalBody> <ModalBody><p>{_("Are you sure you want to restart the router?")}</p></ModalBody>
<p>{_("Are you sure you want to restart the router?")}</p>
</ModalBody>
<ModalFooter> <ModalFooter>
<Button onClick={() => setShown(false)}>{_("Cancel")}</Button> <Button onClick={() => setShown(false)}>{_("Cancel")}</Button>
<Button className="btn-danger" onClick={onReboot}> <Button className="btn-danger" onClick={onReboot}>{_("Confirm reboot")}</Button>
{_("Confirm reboot")}
</Button>
</ModalFooter> </ModalFooter>
</Modal> </Modal>
); );
} }
export default RebootButton;

View File

@ -1,32 +1,32 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React, { useEffect, useState } from "react"; import React, { useEffect, useState } from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { Button } from "../../bootstrap/Button";
import { useAlert } from "../../alertContext/AlertContext";
import { ALERT_TYPES } from "../../bootstrap/Alert";
import { useAPIPost } from "../../api/hooks"; import { useAPIPost } from "../../api/hooks";
import { API_STATE } from "../../api/utils"; import { API_STATE } from "../../api/utils";
import { ALERT_TYPES } from "../../bootstrap/Alert";
import Button from "../../bootstrap/Button";
import { formFieldsSize } from "../../bootstrap/constants"; import { formFieldsSize } from "../../bootstrap/constants";
import { useAlert } from "../../context/alertContext/AlertContext";
ResetWiFiSettings.propTypes = { ResetWiFiSettings.propTypes = {
ws: PropTypes.object.isRequired, ws: PropTypes.object.isRequired,
endpoint: PropTypes.string.isRequired, endpoint: PropTypes.string.isRequired,
}; };
function ResetWiFiSettings({ ws, endpoint }) { export default function ResetWiFiSettings({ ws, endpoint }) {
const [isLoading, setIsLoading] = useState(false); const [isLoading, setIsLoading] = useState(false);
useEffect(() => { useEffect(() => {
const module = "wifi"; const module = "wifi";
ws.subscribe(module).bind(module, "reset", () => { ws.subscribe(module)
.bind(module, "reset", () => {
// eslint-disable-next-line no-restricted-globals // eslint-disable-next-line no-restricted-globals
setTimeout(() => location.reload(), 1000); setTimeout(() => location.reload(), 1000);
}); });
@ -38,40 +38,37 @@ function ResetWiFiSettings({ ws, endpoint }) {
if (postResetResponse.state === API_STATE.ERROR) { if (postResetResponse.state === API_STATE.ERROR) {
setAlert(_("An error occurred during resetting Wi-Fi settings.")); setAlert(_("An error occurred during resetting Wi-Fi settings."));
} else if (postResetResponse.state === API_STATE.SUCCESS) { } else if (postResetResponse.state === API_STATE.SUCCESS) {
setAlert( setAlert(_("Wi-Fi settings are set to defaults."), ALERT_TYPES.SUCCESS);
_("Wi-Fi settings are set to defaults."),
ALERT_TYPES.SUCCESS
);
} }
}, [postResetResponse, setAlert]); }, [postResetResponse, setAlert]);
const onReset = () => { function onReset() {
dismissAlert(); dismissAlert();
setIsLoading(true); setIsLoading(true);
postReset(); postReset();
}; }
return ( return (
<div className={formFieldsSize}> <>
<h2>{_("Reset Wi-Fi Settings")}</h2> <h4>{_("Reset Wi-Fi Settings")}</h4>
<p> <p>
{_( {_(`
"If a number of wireless cards doesn't match, you may try to reset the Wi-Fi settings. Note that this will remove the current Wi-Fi configuration and restore the default values." If a number of wireless cards doesn't match, you may try to reset the Wi-Fi settings. Note that this will remove the
)} current Wi-Fi configuration and restore the default values.
`)}
</p> </p>
<div className="text-end"> <div className={`${formFieldsSize} text-right`}>
<Button <Button
className="btn-primary" className="btn-warning"
forisFormSize forisFormSize
loading={isLoading} loading={isLoading}
disabled={isLoading} disabled={isLoading}
onClick={onReset} onClick={onReset}
> >
{_("Reset Wi-Fi Settings")} {_("Reset Wi-Fi Settings")}
</Button> </Button>
</div> </div>
</div> </>
); );
} }
export default ResetWiFiSettings;

View File

@ -1,43 +1,42 @@
/* /*
* Copyright (C) 2019-2022 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { HELP_TEXTS, HTMODES, HWMODES, ENCRYPTIONMODES } from "./constants"; import { CheckBox } from "../../bootstrap/CheckBox";
import WifiGuestForm from "./WiFiGuestForm"; import { PasswordInput } from "../../bootstrap/PasswordInput";
import { RadioSet } from "../../bootstrap/RadioSet";
import { Select } from "../../bootstrap/Select";
import { TextInput } from "../../bootstrap/TextInput";
import WiFiQRCode from "./WiFiQRCode"; import WiFiQRCode from "./WiFiQRCode";
import PasswordInput from "../../bootstrap/PasswordInput"; import WifiGuestForm from "./WiFiGuestForm";
import RadioSet from "../../bootstrap/RadioSet"; import { HELP_TEXTS, HTMODES, HWMODES } from "./constants";
import Select from "../../bootstrap/Select";
import Switch from "../../bootstrap/Switch";
import TextInput from "../../bootstrap/TextInput";
WiFiForm.propTypes = { WiFiForm.propTypes = {
formData: PropTypes.shape({ devices: PropTypes.arrayOf(PropTypes.object) }) formData: PropTypes.shape(
.isRequired, { devices: PropTypes.arrayOf(PropTypes.object) },
formErrors: PropTypes.oneOfType([PropTypes.object, PropTypes.array]), ).isRequired,
formErrors: PropTypes.oneOfType([
PropTypes.object,
PropTypes.array,
]),
setFormValue: PropTypes.func.isRequired, setFormValue: PropTypes.func.isRequired,
hasGuestNetwork: PropTypes.bool, hasGuestNetwork: PropTypes.bool,
}; };
WiFiForm.defaultProps = { WiFiForm.defaultProps = {
formData: { devices: [] }, formData: { devices: [] },
setFormValue: () => {}, setFormValue: () => { },
hasGuestNetwork: true, hasGuestNetwork: true,
}; };
export default function WiFiForm({ export default function WiFiForm({
formData, formData, formErrors, setFormValue, hasGuestNetwork, disabled,
formErrors,
setFormValue,
hasGuestNetwork,
disabled,
}) { }) {
return formData.devices.map((device, index) => ( return formData.devices.map((device, index) => (
<DeviceForm <DeviceForm
@ -48,7 +47,6 @@ export default function WiFiForm({
setFormValue={setFormValue} setFormValue={setFormValue}
hasGuestNetwork={hasGuestNetwork} hasGuestNetwork={hasGuestNetwork}
disabled={disabled} disabled={disabled}
divider={index + 1 !== formData.devices.length}
/> />
)); ));
} }
@ -64,15 +62,11 @@ DeviceForm.propTypes = {
htmode: PropTypes.string.isRequired, htmode: PropTypes.string.isRequired,
channel: PropTypes.string.isRequired, channel: PropTypes.string.isRequired,
guest_wifi: PropTypes.object.isRequired, guest_wifi: PropTypes.object.isRequired,
encryption: PropTypes.string.isRequired,
available_bands: PropTypes.array.isRequired,
ieee80211w_disabled: PropTypes.bool,
}), }),
formErrors: PropTypes.object.isRequired, formErrors: PropTypes.object.isRequired,
setFormValue: PropTypes.func.isRequired, setFormValue: PropTypes.func.isRequired,
hasGuestNetwork: PropTypes.bool, hasGuestNetwork: PropTypes.bool,
deviceIndex: PropTypes.number, deviceIndex: PropTypes.number,
divider: PropTypes.bool,
}; };
DeviceForm.defaultProps = { DeviceForm.defaultProps = {
@ -81,76 +75,78 @@ DeviceForm.defaultProps = {
}; };
function DeviceForm({ function DeviceForm({
formData, formData, formErrors, setFormValue, hasGuestNetwork, deviceIndex, ...props
formErrors,
setFormValue,
hasGuestNetwork,
deviceIndex,
divider,
...props
}) { }) {
const deviceID = formData.id; const deviceID = formData.id;
const bnds = formData.available_bands;
return ( return (
<> <>
<Switch <h3>{_(`Wi-Fi ${deviceID + 1}`)}</h3>
label={<h2 className="mb-0">{_(`Wi-Fi ${deviceID + 1}`)}</h2>} <CheckBox
label={_("Enable")}
checked={formData.enabled} checked={formData.enabled}
onChange={setFormValue((value) => ({
devices: { onChange={setFormValue(
[deviceIndex]: { enabled: { $set: value } }, (value) => ({ devices: { [deviceIndex]: { enabled: { $set: value } } } }),
}, )}
}))}
switchHeading
{...props} {...props}
/> />
{formData.enabled && ( {formData.enabled
? (
<> <>
<TextInput <TextInput
label="SSID" label="SSID"
value={formData.SSID} value={formData.SSID}
error={formErrors.SSID || null} error={formErrors.SSID || null}
helpText={HELP_TEXTS.ssid}
required required
onChange={setFormValue((value) => ({ onChange={setFormValue(
(value) => ({
devices: { devices: {
[deviceIndex]: { [deviceIndex]: {
SSID: { $set: value }, SSID: { $set: value },
}, },
}, },
}))} }),
)}
{...props} {...props}
> >
<div className="input-group-append">
<WiFiQRCode <WiFiQRCode
SSID={formData.SSID} SSID={formData.SSID}
password={formData.password} password={formData.password}
/> />
</div>
</TextInput> </TextInput>
<PasswordInput <PasswordInput
withEye withEye
label={_("Password")} label="Password"
value={formData.password} value={formData.password}
error={formErrors.password} error={formErrors.password}
helpText={HELP_TEXTS.password} helpText={HELP_TEXTS.password}
required required
onChange={setFormValue((value) => ({
devices: { onChange={setFormValue(
[deviceIndex]: { password: { $set: value } }, (value) => (
}, { devices: { [deviceIndex]: { password: { $set: value } } } }
}))} ),
)}
{...props} {...props}
/> />
<Switch <CheckBox
label={_("Hide SSID")} label="Hide SSID"
helpText={HELP_TEXTS.hidden} helpText={HELP_TEXTS.hidden}
checked={formData.hidden} checked={formData.hidden}
onChange={setFormValue((value) => ({
devices: { onChange={setFormValue(
[deviceIndex]: { hidden: { $set: value } }, (value) => (
}, { devices: { [deviceIndex]: { hidden: { $set: value } } } }
}))} ),
)}
{...props} {...props}
/> />
@ -160,99 +156,63 @@ function DeviceForm({
choices={getHwmodeChoices(formData)} choices={getHwmodeChoices(formData)}
value={formData.hwmode} value={formData.hwmode}
helpText={HELP_TEXTS.hwmode} helpText={HELP_TEXTS.hwmode}
inline
onChange={setFormValue((value) => { onChange={setFormValue(
// Get the last item in an array of available HT modes (value) => ({
const [best2] = bnds[0].available_htmodes.slice(-1);
const [best5] = bnds[1].available_htmodes.slice(-1);
return {
devices: { devices: {
[deviceIndex]: { [deviceIndex]: {
hwmode: { $set: value }, hwmode: { $set: value },
channel: { $set: "0" }, channel: { $set: "0" },
htmode: {
$set:
// Set HT mode depending on checked frequency
value === "11a" ? best5 : best2,
}, },
}, },
}, }),
}; )}
})}
{...props} {...props}
/> />
<Select <Select
label={_("802.11n/ac/ax mode")} label="802.11n/ac mode"
choices={getHtmodeChoices(formData)} choices={getHtmodeChoices(formData)}
value={formData.htmode} value={formData.htmode}
helpText={HELP_TEXTS.htmode} helpText={HELP_TEXTS.htmode}
onChange={setFormValue((value) => ({
devices: { onChange={setFormValue(
[deviceIndex]: { htmode: { $set: value } }, (value) => (
}, { devices: { [deviceIndex]: { htmode: { $set: value } } } }
}))} ),
)}
{...props} {...props}
/> />
<Select <Select
label={_("Channel")} label="Channel"
choices={getChannelChoices(formData)} choices={getChannelChoices(formData)}
value={formData.channel} value={formData.channel}
onChange={setFormValue((value) => ({
devices: {
[deviceIndex]: { channel: { $set: value } },
},
}))}
{...props}
/>
<Select onChange={setFormValue(
label={_("Encryption")} (value) => (
choices={getEncryptionChoices(formData)} { devices: { [deviceIndex]: { channel: { $set: value } } } }
helpText={HELP_TEXTS.wpa3} ),
value={formData.encryption} )}
onChange={setFormValue((value) => ({
devices: {
[deviceIndex]: { encryption: { $set: value } },
},
}))}
{...props}
/>
{(formData.encryption === "WPA3" ||
formData.encryption === "WPA2/3") && (
<Switch
label={_("Disable Management Frame Protection")}
helpText={_(
"In case you have trouble connecting to WiFi Access Point, try disabling Management Frame Protection."
)}
checked={formData.ieee80211w_disabled}
onChange={setFormValue((value) => ({
devices: {
[deviceIndex]: {
ieee80211w_disabled: { $set: value },
},
},
}))}
{...props} {...props}
/> />
)}
{hasGuestNetwork && ( {hasGuestNetwork && (
<WifiGuestForm <WifiGuestForm
formData={{ formData={{ id: deviceIndex, ...formData.guest_wifi }}
id: deviceIndex,
...formData.guest_wifi,
}}
formErrors={formErrors.guest_wifi || {}} formErrors={formErrors.guest_wifi || {}}
setFormValue={setFormValue} setFormValue={setFormValue}
{...props} {...props}
/> />
)} )}
</> </>
)} )
{divider && <hr />} : null}
</> </>
); );
} }
@ -268,9 +228,7 @@ function getChannelChoices(device) {
availableBand.available_channels.forEach((availableChannel) => { availableBand.available_channels.forEach((availableChannel) => {
channelChoices[availableChannel.number.toString()] = ` channelChoices[availableChannel.number.toString()] = `
${availableChannel.number} ${availableChannel.number}
(${availableChannel.frequency} MHz ${ (${availableChannel.frequency} MHz ${availableChannel.radar ? " ,DFS" : ""})
availableChannel.radar ? " ,DFS" : ""
})
`; `;
}); });
}); });
@ -297,10 +255,3 @@ function getHwmodeChoices(device) {
value: availableBand.hwmode, value: availableBand.hwmode,
})); }));
} }
function getEncryptionChoices(device) {
if (device.encryption === "custom") {
ENCRYPTIONMODES.custom = _("Custom");
}
return ENCRYPTIONMODES;
}

View File

@ -1,19 +1,18 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { HELP_TEXTS } from "./constants"; import { CheckBox } from "../../bootstrap/CheckBox";
import { TextInput } from "../../bootstrap/TextInput";
import { PasswordInput } from "../../bootstrap/PasswordInput";
import WiFiQRCode from "./WiFiQRCode"; import WiFiQRCode from "./WiFiQRCode";
import PasswordInput from "../../bootstrap/PasswordInput"; import { HELP_TEXTS } from "./constants";
import Switch from "../../bootstrap/Switch";
import TextInput from "../../bootstrap/TextInput";
WifiGuestForm.propTypes = { WifiGuestForm.propTypes = {
formData: PropTypes.shape({ formData: PropTypes.shape({
@ -27,45 +26,42 @@ WifiGuestForm.propTypes = {
password: PropTypes.string, password: PropTypes.string,
}), }),
setFormValue: PropTypes.func.isRequired, setFormValue: PropTypes.func.isRequired,
deviceIndex: PropTypes.string,
}; };
export default function WifiGuestForm({ export default function WifiGuestForm({
formData, formData, formErrors, setFormValue, ...props
formErrors,
setFormValue,
deviceIndex,
...props
}) { }) {
return ( return (
<> <>
<Switch <CheckBox
label={_("Enable Guest Wi-Fi")} label={_("Enable Guest Wifi")}
checked={formData.enabled} checked={formData.enabled}
helpText={HELP_TEXTS.guest_wifi_enabled} helpText={HELP_TEXTS.guest_wifi_enabled}
onChange={setFormValue((value) => ({
devices: { onChange={setFormValue(
[formData.id]: { (value) => (
guest_wifi: { enabled: { $set: value } }, { devices: { [formData.id]: { guest_wifi: { enabled: { $set: value } } } } }
}, ),
}, )}
}))}
{...props} {...props}
/> />
{formData.enabled ? ( {formData.enabled
? (
<> <>
<TextInput <TextInput
label="SSID" label="SSID"
value={formData.SSID} value={formData.SSID}
error={formErrors.SSID} error={formErrors.SSID}
helpText={HELP_TEXTS.ssid}
onChange={setFormValue((value) => ({ onChange={setFormValue(
(value) => ({
devices: { devices: {
[formData.id]: { [formData.id]: { guest_wifi: { SSID: { $set: value } } },
guest_wifi: { SSID: { $set: value } },
}, },
}, }),
}))} )}
{...props} {...props}
> >
<div className="input-group-append"> <div className="input-group-append">
@ -83,17 +79,22 @@ export default function WifiGuestForm({
helpText={HELP_TEXTS.password} helpText={HELP_TEXTS.password}
error={formErrors.password} error={formErrors.password}
required required
onChange={setFormValue((value) => ({
onChange={setFormValue(
(value) => ({
devices: { devices: {
[formData.id]: { [formData.id]: {
guest_wifi: { password: { $set: value } }, guest_wifi: { password: { $set: value } },
}, },
}, },
}))} }),
)}
{...props} {...props}
/> />
</> </>
) : null} )
: null}
</> </>
); );
} }

View File

@ -1,30 +1,28 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React, { useState } from "react"; import React, { useState } from "react";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import PropTypes from "prop-types";
import QRCode from "qrcode.react"; import QRCode from "qrcode.react";
import PropTypes from "prop-types";
import { createAndDownloadPdf, toQRCodeContent } from "./qrCodeHelpers"; import { ForisURLs } from "../../utils/forisUrls";
import Button from "../../bootstrap/Button"; import { Button } from "../../bootstrap/Button";
import { import {
Modal, Modal, ModalBody, ModalFooter, ModalHeader,
ModalBody,
ModalFooter,
ModalHeader,
} from "../../bootstrap/Modal"; } from "../../bootstrap/Modal";
import { createAndDownloadPdf, toQRCodeContent } from "./qrCodeHelpers";
WiFiQRCode.propTypes = { WiFiQRCode.propTypes = {
SSID: PropTypes.string.isRequired, SSID: PropTypes.string.isRequired,
password: PropTypes.string.isRequired, password: PropTypes.string.isRequired,
}; };
const QR_ICON_PATH = `${ForisURLs.static}/imgs/QR_icon.svg`;
export default function WiFiQRCode({ SSID, password }) { export default function WiFiQRCode({ SSID, password }) {
const [modal, setModal] = useState(false); const [modal, setModal] = useState(false);
@ -38,21 +36,11 @@ export default function WiFiQRCode({ SSID, password }) {
setModal(true); setModal(true);
}} }}
> >
<FontAwesomeIcon <img width="20" src={QR_ICON_PATH} alt="QR" style={{ opacity: 0.67 }} />
icon="fa-solid fa-qrcode"
title={_("Show QR code")}
aria-label={_("Show QR code")}
className="text-dark"
/>
</button> </button>
{modal ? ( {modal
<QRCodeModal ? <QRCodeModal setShown={setModal} shown={modal} SSID={SSID} password={password} />
setShown={setModal} : null}
shown={modal}
SSID={SSID}
password={password}
/>
) : null}
</> </>
); );
} }
@ -64,7 +52,9 @@ QRCodeModal.propTypes = {
setShown: PropTypes.func.isRequired, setShown: PropTypes.func.isRequired,
}; };
function QRCodeModal({ shown, setShown, SSID, password }) { function QRCodeModal({
shown, setShown, SSID, password,
}) {
return ( return (
<Modal setShown={setShown} shown={shown}> <Modal setShown={setShown} shown={shown}>
<ModalHeader setShown={setShown} title={_("Wi-Fi QR Code")} /> <ModalHeader setShown={setShown} title={_("Wi-Fi QR Code")} />
@ -86,10 +76,7 @@ function QRCodeModal({ shown, setShown, SSID, password }) {
createAndDownloadPdf(SSID, password); createAndDownloadPdf(SSID, password);
}} }}
> >
<FontAwesomeIcon <i className="fas fa-arrow-down mr-2" />
icon="fa-solid fa-file-download"
className="me-2"
/>
{_("Download PDF")} {_("Download PDF")}
</Button> </Button>
</ModalFooter> </ModalFooter>

View File

@ -1,17 +1,16 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import ResetWiFiSettings from "./ResetWiFiSettings"; import { ForisForm } from "../../form/components/ForisForm";
import WiFiForm from "./WiFiForm"; import WiFiForm from "./WiFiForm";
import ForisForm from "../../form/components/ForisForm"; import ResetWiFiSettings from "./ResetWiFiSettings";
WiFiSettings.propTypes = { WiFiSettings.propTypes = {
ws: PropTypes.object.isRequired, ws: PropTypes.object.isRequired,
@ -20,7 +19,9 @@ WiFiSettings.propTypes = {
hasGuestNetwork: PropTypes.bool, hasGuestNetwork: PropTypes.bool,
}; };
function WiFiSettings({ ws, endpoint, resetEndpoint, hasGuestNetwork }) { export function WiFiSettings({
ws, endpoint, resetEndpoint, hasGuestNetwork,
}) {
return ( return (
<> <>
<ForisForm <ForisForm
@ -58,65 +59,35 @@ function prepDataToSubmit(formData) {
return; return;
} }
if (!device.guest_wifi.enabled) if (!device.guest_wifi.enabled) formData.devices[idx].guest_wifi = { enabled: false };
formData.devices[idx].guest_wifi = { enabled: false };
if (device.encryption === "WPA2") {
delete formData.devices[idx].ieee80211w_disabled;
}
}); });
return formData; return formData;
} }
export function byteCount(string) {
const buffer = Buffer.from(string, "utf-8");
const count = buffer.byteLength;
return count;
}
export function validator(formData) { export function validator(formData) {
const formErrors = formData.devices.map((device) => { const formErrors = formData.devices.map(
(device) => {
if (!device.enabled) return {}; if (!device.enabled) return {};
const errors = {}; const errors = {};
if (device.SSID.length > 32) if (device.SSID.length > 32) errors.SSID = _("SSID can't be longer than 32 symbols");
errors.SSID = _("SSID can't be longer than 32 symbols");
if (device.SSID.length === 0) errors.SSID = _("SSID can't be empty"); if (device.SSID.length === 0) errors.SSID = _("SSID can't be empty");
if (byteCount(device.SSID) > 32)
errors.SSID = _("SSID can't be longer than 32 bytes");
if (device.password.length < 8) if (device.password.length < 8) errors.password = _("Password must contain at least 8 symbols");
errors.password = _("Password must contain at least 8 symbols");
if (device.password.length >= 64)
errors.password = _(
"Password must not contain more than 63 symbols"
);
if (!device.guest_wifi.enabled) return errors; if (!device.guest_wifi.enabled) return errors;
const guest_wifi_errors = {}; const guest_wifi_errors = {};
if (device.guest_wifi.SSID.length > 32) if (device.guest_wifi.SSID.length > 32) guest_wifi_errors.SSID = _("SSID can't be longer than 32 symbols");
guest_wifi_errors.SSID = _("SSID can't be longer than 32 symbols"); if (device.guest_wifi.SSID.length === 0) guest_wifi_errors.SSID = _("SSID can't be empty");
if (device.guest_wifi.SSID.length === 0)
guest_wifi_errors.SSID = _("SSID can't be empty");
if (byteCount(device.guest_wifi.SSID) > 32)
guest_wifi_errors.SSID = _("SSID can't be longer than 32 bytes");
if (device.guest_wifi.password.length < 8) if (device.guest_wifi.password.length < 8) guest_wifi_errors.password = _("Password must contain at least 8 symbols");
guest_wifi_errors.password = _(
"Password must contain at least 8 symbols"
);
if (device.guest_wifi.password.length >= 64)
guest_wifi_errors.password = _(
"Password must not contain more than 63 symbols"
);
if (guest_wifi_errors.SSID || guest_wifi_errors.password) { if (guest_wifi_errors.SSID || guest_wifi_errors.password) {
errors.guest_wifi = guest_wifi_errors; errors.guest_wifi = guest_wifi_errors;
} }
return errors; return errors;
}); },
);
return JSON.stringify(formErrors).match(/\[[{},?]+\]/) ? null : formErrors; return JSON.stringify(formErrors).match(/\[[{},?]+\]/) ? null : formErrors;
} }
export default WiFiSettings;

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (C) 2019-2021 CZ.NIC z.s.p.o. (http://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
@ -9,7 +9,7 @@ import React from "react";
import { render, fireEvent, wait } from "customTestRender"; import { render, fireEvent, wait } from "customTestRender";
import mockAxios from "jest-mock-axios"; import mockAxios from "jest-mock-axios";
import WebSockets from "webSockets/WebSockets"; import { WebSockets } from "webSockets/WebSockets";
import { mockJSONError } from "testUtils/network"; import { mockJSONError } from "testUtils/network";
import { mockSetAlert } from "testUtils/alertContextMock"; import { mockSetAlert } from "testUtils/alertContextMock";
import { ALERT_TYPES } from "../../../bootstrap/Alert"; import { ALERT_TYPES } from "../../../bootstrap/Alert";
@ -22,34 +22,19 @@ describe("<ResetWiFiSettings/>", () => {
let getAllByText; let getAllByText;
beforeEach(() => { beforeEach(() => {
({ getAllByText } = render( ({ getAllByText } = render(<ResetWiFiSettings ws={webSockets} endpoint={endpoint} />));
<ResetWiFiSettings ws={webSockets} endpoint={endpoint} />
));
}); });
it("should display alert on open ports - success", async () => { it("should display alert on open ports - success", async () => {
fireEvent.click(getAllByText("Reset Wi-Fi Settings")[1]); fireEvent.click(getAllByText("Reset Wi-Fi Settings")[1]);
expect(mockAxios.post).toBeCalledWith( expect(mockAxios.post).toBeCalledWith(endpoint, undefined, expect.anything());
endpoint,
undefined,
expect.anything()
);
mockAxios.mockResponse({ data: { foo: "bar" } }); mockAxios.mockResponse({ data: { foo: "bar" } });
await wait(() => await wait(() => expect(mockSetAlert).toBeCalledWith("Wi-Fi settings are set to defaults.", ALERT_TYPES.SUCCESS));
expect(mockSetAlert).toBeCalledWith(
"Wi-Fi settings are set to defaults.",
ALERT_TYPES.SUCCESS
)
);
}); });
it("should display alert on open ports - failure", async () => { it("should display alert on open ports - failure", async () => {
fireEvent.click(getAllByText("Reset Wi-Fi Settings")[1]); fireEvent.click(getAllByText("Reset Wi-Fi Settings")[1]);
mockJSONError(); mockJSONError();
await wait(() => await wait(() => expect(mockSetAlert).toBeCalledWith("An error occurred during resetting Wi-Fi settings."));
expect(mockSetAlert).toBeCalledWith(
"An error occurred during resetting Wi-Fi settings."
)
);
}); });
}); });

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (C) 2019-2021 CZ.NIC z.s.p.o. (http://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
@ -10,39 +10,26 @@ import diffSnapshot from "snapshot-diff";
import mockAxios from "jest-mock-axios"; import mockAxios from "jest-mock-axios";
import { fireEvent, render, wait } from "customTestRender"; import { fireEvent, render, wait } from "customTestRender";
import WebSockets from "webSockets/WebSockets"; import { WebSockets } from "webSockets/WebSockets";
import { mockJSONError } from "testUtils/network"; import { mockJSONError } from "testUtils/network";
import { import { wifiSettingsFixture, oneDevice, twoDevices, threeDevices } from "./__fixtures__/wifiSettings";
wifiSettingsFixture, import { WiFiSettings, validator } from "../WiFiSettings";
oneDevice,
twoDevices,
threeDevices,
} from "./__fixtures__/wifiSettings";
import WiFiSettings, { validator, byteCount } from "../WiFiSettings";
describe("<WiFiSettings/>", () => { describe("<WiFiSettings/>", () => {
let firstRender; let firstRender;
let getAllByText; let getAllByText;
let getAllByLabelText; let getAllByLabelText;
let getByText; let getByText;
let getByLabelText;
let asFragment; let asFragment;
const endpoint = "/reforis/api/wifi"; const endpoint = "/reforis/api/wifi";
beforeEach(async () => { beforeEach(async () => {
const webSockets = new WebSockets(); const webSockets = new WebSockets();
const renderRes = render( const renderRes = render(<WiFiSettings ws={webSockets} endpoint={endpoint} resetEndpoint="foo" />);
<WiFiSettings
ws={webSockets}
endpoint={endpoint}
resetEndpoint="foo"
/>
);
asFragment = renderRes.asFragment; asFragment = renderRes.asFragment;
getAllByText = renderRes.getAllByText; getAllByText = renderRes.getAllByText;
getAllByLabelText = renderRes.getAllByLabelText; getAllByLabelText = renderRes.getAllByLabelText;
getByLabelText = renderRes.getByLabelText;
getByText = renderRes.getByText; getByText = renderRes.getByText;
mockAxios.mockResponse({ data: wifiSettingsFixture() }); mockAxios.mockResponse({ data: wifiSettingsFixture() });
await wait(() => renderRes.getByText("Wi-Fi 1")); await wait(() => renderRes.getByText("Wi-Fi 1"));
@ -51,13 +38,7 @@ describe("<WiFiSettings/>", () => {
it("should handle error", async () => { it("should handle error", async () => {
const webSockets = new WebSockets(); const webSockets = new WebSockets();
const { getByText } = render( const { getByText } = render(<WiFiSettings ws={webSockets} ws={webSockets} endpoint={endpoint} resetEndpoint="foo" />);
<WiFiSettings
ws={webSockets}
endpoint={endpoint}
resetEndpoint="foo"
/>
);
const errorMessage = "An API error occurred."; const errorMessage = "An API error occurred.";
mockJSONError(errorMessage); mockJSONError(errorMessage);
await wait(() => { await wait(() => {
@ -70,21 +51,21 @@ describe("<WiFiSettings/>", () => {
}); });
it("Snapshot one module enabled.", () => { it("Snapshot one module enabled.", () => {
fireEvent.click(getByText("Wi-Fi 1")); fireEvent.click(getAllByText("Enable")[0]);
expect(diffSnapshot(firstRender, asFragment())).toMatchSnapshot(); expect(diffSnapshot(firstRender, asFragment())).toMatchSnapshot();
}); });
it("Snapshot 2.4 GHz", () => { it("Snapshot 2.4 GHz", () => {
fireEvent.click(getByText("Wi-Fi 1")); fireEvent.click(getAllByText("Enable")[0]);
const enabledRender = asFragment(); const enabledRender = asFragment();
fireEvent.click(getAllByText("2.4")[0]); fireEvent.click(getAllByText("2.4")[0]);
expect(diffSnapshot(enabledRender, asFragment())).toMatchSnapshot(); expect(diffSnapshot(enabledRender, asFragment())).toMatchSnapshot();
}); });
it("Snapshot guest network.", () => { it("Snapshot guest network.", () => {
fireEvent.click(getByText("Wi-Fi 1")); fireEvent.click(getAllByText("Enable")[0]);
const enabledRender = asFragment(); const enabledRender = asFragment();
fireEvent.click(getAllByText("Enable Guest Wi-Fi")[0]); fireEvent.click(getAllByText("Enable Guest Wifi")[0]);
expect(diffSnapshot(enabledRender, asFragment())).toMatchSnapshot(); expect(diffSnapshot(enabledRender, asFragment())).toMatchSnapshot();
}); });
@ -97,15 +78,11 @@ describe("<WiFiSettings/>", () => {
{ enabled: false, id: 1 }, { enabled: false, id: 1 },
], ],
}; };
expect(mockAxios.post).toHaveBeenCalledWith( expect(mockAxios.post).toHaveBeenCalledWith(endpoint, data, expect.anything());
endpoint,
data,
expect.anything()
);
}); });
it("Post form: one module enabled.", () => { it("Post form: one module enabled.", () => {
fireEvent.click(getByText("Wi-Fi 1")); fireEvent.click(getAllByText("Enable")[0]);
fireEvent.click(getByText("Save")); fireEvent.click(getByText("Save"));
expect(mockAxios.post).toBeCalled(); expect(mockAxios.post).toBeCalled();
@ -117,24 +94,19 @@ describe("<WiFiSettings/>", () => {
enabled: true, enabled: true,
guest_wifi: { enabled: false }, guest_wifi: { enabled: false },
hidden: false, hidden: false,
htmode: "HT80", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 0, id: 0,
password: "TestPass", password: "TestPass",
encryption: "WPA3",
}, },
{ enabled: false, id: 1 }, { enabled: false, id: 1 },
], ],
}; };
expect(mockAxios.post).toHaveBeenCalledWith( expect(mockAxios.post).toHaveBeenCalledWith(endpoint, data, expect.anything());
endpoint,
data,
expect.anything()
);
}); });
it("Post form: 2.4 GHz", () => { it("Post form: 2.4 GHz", () => {
fireEvent.click(getByText("Wi-Fi 1")); fireEvent.click(getAllByText("Enable")[0]);
fireEvent.click(getAllByText("2.4")[0]); fireEvent.click(getAllByText("2.4")[0]);
fireEvent.click(getByText("Save")); fireEvent.click(getByText("Save"));
@ -147,28 +119,21 @@ describe("<WiFiSettings/>", () => {
enabled: true, enabled: true,
guest_wifi: { enabled: false }, guest_wifi: { enabled: false },
hidden: false, hidden: false,
htmode: "VHT80", htmode: "HT40",
hwmode: "11g", hwmode: "11g",
id: 0, id: 0,
password: "TestPass", password: "TestPass",
encryption: "WPA3",
}, },
{ enabled: false, id: 1 }, { enabled: false, id: 1 },
], ],
}; };
expect(mockAxios.post).toHaveBeenCalledWith( expect(mockAxios.post).toHaveBeenCalledWith(endpoint, data, expect.anything());
endpoint,
data,
expect.anything()
);
}); });
it("Post form: guest network.", () => { it("Post form: guest network.", () => {
fireEvent.click(getByText("Wi-Fi 1")); fireEvent.click(getAllByText("Enable")[0]);
fireEvent.click(getAllByText("Enable Guest Wi-Fi")[0]); fireEvent.click(getAllByText("Enable Guest Wifi")[0]);
fireEvent.change(getAllByLabelText("Password")[1], { fireEvent.change(getAllByLabelText("Password")[1], { target: { value: "test_password" } });
target: { value: "test_password" },
});
fireEvent.click(getByText("Save")); fireEvent.click(getByText("Save"));
expect(mockAxios.post).toBeCalled(); expect(mockAxios.post).toBeCalled();
@ -184,20 +149,15 @@ describe("<WiFiSettings/>", () => {
password: "test_password", password: "test_password",
}, },
hidden: false, hidden: false,
htmode: "HT80", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 0, id: 0,
password: "TestPass", password: "TestPass",
encryption: "WPA3",
}, },
{ enabled: false, id: 1 }, { enabled: false, id: 1 },
], ],
}; };
expect(mockAxios.post).toHaveBeenCalledWith( expect(mockAxios.post).toHaveBeenCalledWith(endpoint, data, expect.anything());
endpoint,
data,
expect.anything()
);
}); });
it("Validator function using regex for one device", () => { it("Validator function using regex for one device", () => {
@ -205,40 +165,12 @@ describe("<WiFiSettings/>", () => {
}); });
it("Validator function using regex for two devices", () => { it("Validator function using regex for two devices", () => {
const twoDevicesFormErrors = [{ SSID: "SSID can't be empty" }, {}]; const twoDevicesFormErrors = [{SSID: "SSID can't be empty"}, {}];
expect(validator(twoDevices)).toEqual(twoDevicesFormErrors); expect(validator(twoDevices)).toEqual(twoDevicesFormErrors);
}); });
it("Validator function using regex for three devices", () => { it("Validator function using regex for three devices", () => {
const threeDevicesFormErrors = [ const threeDevicesFormErrors = [{}, {}, {password: "Password must contain at least 8 symbols"}];
{},
{},
{ password: "Password must contain at least 8 symbols" },
];
expect(validator(threeDevices)).toEqual(threeDevicesFormErrors); expect(validator(threeDevices)).toEqual(threeDevicesFormErrors);
}); });
it("ByteCount function", () => {
expect(byteCount("abc")).toEqual(3);
});
it("Should validate password length", () => {
const shortErrorFeedback = /Password must contain/i;
const longErrorFeedback = /Password must not contain/i;
fireEvent.click(getByText("Wi-Fi 1"));
const passwordInput = getByLabelText("Password");
const changePassword = (value) =>
fireEvent.change(passwordInput, { target: { value } });
changePassword("12");
expect(getByText(shortErrorFeedback)).toBeDefined();
changePassword(
"longpasswordlongpasswordlongpasswordlongpasswordlongpasswordlong"
);
expect(getByText(longErrorFeedback)).toBeDefined();
});
}); });

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (C) 2019-2021 CZ.NIC z.s.p.o. (http://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
@ -226,11 +226,10 @@ export function wifiSettingsFixture() {
password: "", password: "",
}, },
hidden: false, hidden: false,
htmode: "HT80", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 0, id: 0,
password: "TestPass", password: "TestPass",
encryption: "WPA3",
}, },
{ {
SSID: "Turris", SSID: "Turris",
@ -293,7 +292,11 @@ export function wifiSettingsFixture() {
radar: false, radar: false,
}, },
], ],
available_htmodes: ["NOHT", "HT20", "HT40"], available_htmodes: [
"NOHT",
"HT20",
"HT40",
],
hwmode: "11g", hwmode: "11g",
}, },
], ],
@ -309,7 +312,6 @@ export function wifiSettingsFixture() {
hwmode: "11g", hwmode: "11g",
id: 1, id: 1,
password: "TestPass", password: "TestPass",
encryption: "WPA3",
}, },
], ],
}; };
@ -325,10 +327,9 @@ const oneDevice = {
htmode: "HT40", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 0, id: 0,
password: "TestPass", password: "TestPass"
encryption: "WPA3", }
}, ]
],
}; };
const twoDevices = { const twoDevices = {
@ -342,8 +343,7 @@ const twoDevices = {
htmode: "HT40", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 0, id: 0,
password: "TestPass", password: "TestPass"
encryption: "WPA3",
}, },
{ {
SSID: "Turris2", SSID: "Turris2",
@ -353,11 +353,10 @@ const twoDevices = {
hidden: false, hidden: false,
htmode: "HT40", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 1, id: 0,
password: "TestPass", password: "TestPass"
encryption: "WPA3", }
}, ]
],
}; };
const threeDevices = { const threeDevices = {
@ -371,8 +370,7 @@ const threeDevices = {
htmode: "HT40", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 0, id: 0,
password: "TestPass", password: "TestPass"
encryption: "WPA3",
}, },
{ {
SSID: "Turris2", SSID: "Turris2",
@ -382,9 +380,8 @@ const threeDevices = {
hidden: false, hidden: false,
htmode: "HT40", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 1, id: 0,
password: "TestPass", password: "TestPass"
encryption: "WPA3",
}, },
{ {
SSID: "Turris3", SSID: "Turris3",
@ -394,11 +391,10 @@ const threeDevices = {
hidden: false, hidden: false,
htmode: "HT40", htmode: "HT40",
hwmode: "11a", hwmode: "11a",
id: 2, id: 0,
password: "", password: ""
encryption: "WPA3", }
}, ]
],
}; };
export { oneDevice, twoDevices, threeDevices }; export {oneDevice, twoDevices, threeDevices};

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (C) 2019-2022 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
@ -13,40 +13,28 @@ export const HTMODES = {
VHT40: _("802.11ac - 40 MHz wide channel"), VHT40: _("802.11ac - 40 MHz wide channel"),
VHT80: _("802.11ac - 80 MHz wide channel"), VHT80: _("802.11ac - 80 MHz wide channel"),
VHT160: _("802.11ac - 160 MHz wide channel"), VHT160: _("802.11ac - 160 MHz wide channel"),
HE20: _("802.11ax - 20 MHz wide channel"),
HE40: _("802.11ax - 40 MHz wide channel"),
HE80: _("802.11ax - 80 MHz wide channel"),
HE160: _("802.11ax - 160 MHz wide channel"),
}; };
export const HWMODES = { export const HWMODES = {
"11g": "2.4", "11g": "2.4",
"11a": "5", "11a": "5",
}; };
export const ENCRYPTIONMODES = {
WPA3: _("WPA3 only"),
"WPA2/3": _("WPA3 with WPA2 as fallback (default)"),
WPA2: _("WPA2 only"),
};
export const HELP_TEXTS = { export const HELP_TEXTS = {
ssid: _( password: _(`
"SSID which contains non-standard characters could cause problems on some devices." WPA2 pre-shared key, that is required to connect to the network.
), `),
password: _( hidden: _("If set, network is not visible when scanning for available networks."),
"WPA2/3 pre-shared key, that is required to connect to the network." hwmode: _(`
), The 2.4 GHz band is more widely supported by clients, but tends to have more interference. The 5 GHz band is a
hidden: _( newer standard and may not be supported by all your devices. It usually has less interference, but the signal
"If set, network is not visible when scanning for available networks." does not carry so well indoors.`),
), htmode: _(`
hwmode: _( Change this to adjust 802.11n/ac mode of operation. 802.11n with 40 MHz wide channels can yield higher
"The 2.4 GHz band is more widely supported by clients, but tends to have more interference. The 5 GHz band is a newer standard and may not be supported by all your devices. It usually has less interference, but the signal does not carry so well indoors." throughput but can cause more interference in the network. If you don't know what to choose, use the default
), option with 20 MHz wide channel.
htmode: _( `),
"Change this to adjust 802.11n/ac/ax mode of operation. 802.11n with 40 MHz wide channels can yield higher throughput but can cause more interference in the network. If you don't know what to choose, use the default option with 20 MHz wide channel." guest_wifi_enabled: _(`
), Enables Wi-Fi for guests, which is separated from LAN network. Devices connected to this network are allowed to
guest_wifi_enabled: _( access the internet, but aren't allowed to access other devices and the configuration interface of the router.
"Enables Wi-Fi for guests, which is separated from LAN network. Devices connected to this network are allowed to access the internet, but aren't allowed to access other devices and the configuration interface of the router. Parameters of the guest network can be set in the Guest network tab." Parameters of the guest network can be set in the Guest network tab.
), `),
wpa3: _(
"The WPA3 standard is the new most secure encryption method that is suggested to be used with any device that supports it. The older devices without WPA3 support require older WPA2. If you experience issues with connecting older devices, try to enable WPA2."
),
}; };

View File

@ -8,56 +8,49 @@
import React from "react"; import React from "react";
import { import {
fireEvent, fireEvent, getByText, queryByText, render, wait,
getByText,
queryByText,
render,
wait,
} from "customTestRender"; } from "customTestRender";
import mockAxios from "jest-mock-axios"; import mockAxios from "jest-mock-axios";
import { mockJSONError } from "testUtils/network"; import { mockJSONError } from "testUtils/network";
import { mockSetAlert } from "testUtils/alertContextMock"; import { mockSetAlert } from "testUtils/alertContextMock";
import RebootButton from "../RebootButton"; import { RebootButton } from "../RebootButton";
describe("<RebootButton/>", () => { describe("<RebootButton/>", () => {
let componentContainer; let componentContainer;
beforeEach(() => { beforeEach(() => {
const { container } = render( const { container } = render(<>
<>
<div id="modal-container" /> <div id="modal-container" />
<RebootButton /> <RebootButton />
</> </>);
);
componentContainer = container; componentContainer = container;
}); });
it("Render.", () => { it("Render.", () => {
expect(componentContainer).toMatchSnapshot(); expect(componentContainer)
.toMatchSnapshot();
}); });
it("Render modal.", () => { it("Render modal.", () => {
expect(queryByText(componentContainer, "Confirm reboot")).toBeNull(); expect(queryByText(componentContainer, "Confirm reboot"))
.toBeNull();
fireEvent.click(getByText(componentContainer, "Reboot")); fireEvent.click(getByText(componentContainer, "Reboot"));
expect(componentContainer).toMatchSnapshot(); expect(componentContainer)
.toMatchSnapshot();
}); });
it("Confirm reboot.", () => { it("Confirm reboot.", () => {
fireEvent.click(getByText(componentContainer, "Reboot")); fireEvent.click(getByText(componentContainer, "Reboot"));
fireEvent.click(getByText(componentContainer, "Confirm reboot")); fireEvent.click(getByText(componentContainer, "Confirm reboot"));
expect(mockAxios.post).toHaveBeenCalledWith( expect(mockAxios.post)
"/reforis/api/reboot", .toHaveBeenCalledWith("/reforis/api/reboot", undefined, expect.anything());
undefined,
expect.anything()
);
}); });
it("Hold error.", async () => { it("Hold error.", async () => {
fireEvent.click(getByText(componentContainer, "Reboot")); fireEvent.click(getByText(componentContainer, "Reboot"));
fireEvent.click(getByText(componentContainer, "Confirm reboot")); fireEvent.click(getByText(componentContainer, "Confirm reboot"));
mockJSONError(); mockJSONError();
await wait(() => await wait(() => expect(mockSetAlert)
expect(mockSetAlert).toBeCalledWith("Reboot request failed.") .toBeCalledWith("Reboot request failed."));
);
}); });
}); });

View File

@ -22,13 +22,18 @@ exports[`<RebootButton/> Render modal. 1`] = `
<h5 <h5
class="modal-title" class="modal-title"
> >
Warning! Reboot confirmation
</h5> </h5>
<button <button
aria-label="Close" class="close"
class="btn-close"
type="button" type="button"
/> >
<span
aria-hidden="true"
>
×
</span>
</button>
</div> </div>
<div <div
class="modal-body" class="modal-body"
@ -41,20 +46,20 @@ exports[`<RebootButton/> Render modal. 1`] = `
class="modal-footer" class="modal-footer"
> >
<button <button
class="btn btn-primary d-inline-flex justify-content-center align-items-center" class="btn btn-primary "
type="button" type="button"
> >
<span>
Cancel Cancel
</span>
</button> </button>
<button <button
class="btn btn-danger d-inline-flex justify-content-center align-items-center" class="btn btn-danger"
type="button" type="button"
> >
<span>
Confirm reboot Confirm reboot
</span>
</button> </button>
</div> </div>
</div> </div>
@ -62,12 +67,12 @@ exports[`<RebootButton/> Render modal. 1`] = `
</div> </div>
</div> </div>
<button <button
class="btn btn-danger d-inline-flex justify-content-center align-items-center" class="btn btn-danger"
type="button" type="button"
> >
<span>
Reboot Reboot
</span>
</button> </button>
</div> </div>
`; `;
@ -78,12 +83,12 @@ exports[`<RebootButton/> Render. 1`] = `
id="modal-container" id="modal-container"
/> />
<button <button
class="btn btn-danger d-inline-flex justify-content-center align-items-center" class="btn btn-danger"
type="button" type="button"
> >
<span>
Reboot Reboot
</span>
</button> </button>
</div> </div>
`; `;

View File

@ -1,68 +0,0 @@
/*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/)
*
* This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information.
*/
import React, { useContext, useEffect, useMemo } from "react";
import PropTypes from "prop-types";
import { useAPIGet } from "../../api/hooks";
import { Spinner } from "../../bootstrap/Spinner";
import { ForisURLs } from "../../utils/forisUrls";
CustomizationContextProvider.propTypes = {
children: PropTypes.oneOfType([
PropTypes.arrayOf(PropTypes.node),
PropTypes.node,
]),
};
function CustomizationContextProvider({ children }) {
const { CustomizationContext } = window;
const [getCustomizationResponse, getCustomization] = useAPIGet(
ForisURLs.about
);
useEffect(() => {
getCustomization();
}, [getCustomization]);
const deviceDetails = useMemo(
() => getCustomizationResponse.data || {},
[getCustomizationResponse.data]
);
const isCustomized = useMemo(
() =>
!!(
deviceDetails.customization !== undefined &&
deviceDetails.customization === "shield"
),
[deviceDetails.customization]
);
const contextValue = useMemo(
() => ({ deviceDetails, isCustomized }),
[deviceDetails, isCustomized]
);
if (getCustomizationResponse.state !== "success") {
return <Spinner fullScreen />;
}
return (
<CustomizationContext.Provider value={contextValue}>
{children}
</CustomizationContext.Provider>
);
}
function useCustomizationContext() {
const { CustomizationContext } = window;
return useContext(CustomizationContext);
}
export { CustomizationContextProvider, useCustomizationContext };

View File

@ -1,3 +0,0 @@
It provides customization context to the children. `CustomizationContext` allows
using `useCustomizationContext` in components to check if the reForis UI is
customized or not for specific devices.

View File

@ -1,53 +0,0 @@
/*
* Copyright (C) 2019-2022 CZ.NIC z.s.p.o. (https://www.nic.cz/)
*
* This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information.
*/
import React from "react";
import { render, wait, getByText } from "customTestRender";
import mockAxios from "jest-mock-axios";
import {
useCustomizationContext,
CustomizationContextProvider,
} from "../CustomizationContext";
const CUSTOM = "Description / component for customized reForis (Shield)";
const ORIGINAL = "Description / component for original reForis (other devices)";
const CustomizationTest = () => {
const { isCustomized } = useCustomizationContext();
return <p>{isCustomized ? CUSTOM : ORIGINAL}</p>;
};
describe("CustomizationContext", () => {
let componentContainer;
beforeEach(() => {
const { container } = render(
<CustomizationContextProvider>
<CustomizationTest />
</CustomizationContextProvider>
);
componentContainer = container;
});
it("should render component without customization", async () => {
mockAxios.mockResponse({ data: {} });
await wait(() => getByText(componentContainer, ORIGINAL));
expect(componentContainer).toMatchSnapshot();
});
it("should render customized component", async () => {
mockAxios.mockResponse({ data: { customization: "shield" } });
await wait(() => getByText(componentContainer, CUSTOM));
expect(componentContainer).toMatchSnapshot();
});
});

View File

@ -1,17 +0,0 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`CustomizationContext should render component without customization 1`] = `
<div>
<p>
Description / component for original reForis (other devices)
</p>
</div>
`;
exports[`CustomizationContext should render customized component 1`] = `
<div>
<p>
Description / component for customized reForis (Shield)
</p>
</div>
`;

View File

@ -13,14 +13,17 @@ import { STATES, SubmitButton } from "../components/SubmitButton";
describe("<SubmitButton/>", () => { describe("<SubmitButton/>", () => {
it("Render ready", () => { it("Render ready", () => {
const { container } = render(<SubmitButton state={STATES.READY} />); const { container } = render(<SubmitButton state={STATES.READY} />);
expect(container).toMatchSnapshot(); expect(container)
.toMatchSnapshot();
}); });
it("Render saving", () => { it("Render saving", () => {
const { container } = render(<SubmitButton state={STATES.SAVING} />); const { container } = render(<SubmitButton state={STATES.SAVING} />);
expect(container).toMatchSnapshot(); expect(container)
.toMatchSnapshot();
}); });
it("Render load", () => { it("Render load", () => {
const { container } = render(<SubmitButton state={STATES.LOAD} />); const { container } = render(<SubmitButton state={STATES.LOAD} />);
expect(container).toMatchSnapshot(); expect(container)
.toMatchSnapshot();
}); });
}); });

View File

@ -3,18 +3,19 @@
exports[`<SubmitButton/> Render load 1`] = ` exports[`<SubmitButton/> Render load 1`] = `
<div> <div>
<button <button
class="btn btn-primary col-12 col-md-3 col-lg-2 d-inline-flex justify-content-center align-items-center" class="btn btn-primary col-sm-12 col-lg-3"
disabled="" disabled=""
type="submit" type="submit"
> >
<span <span
aria-hidden="true" aria-hidden="true"
class="spinner-border spinner-border-sm me-1" class="spinner-border spinner-border-sm"
role="status" role="status"
/> />
<span>
Load settings Load settings
</span>
</button> </button>
</div> </div>
`; `;
@ -22,12 +23,12 @@ exports[`<SubmitButton/> Render load 1`] = `
exports[`<SubmitButton/> Render ready 1`] = ` exports[`<SubmitButton/> Render ready 1`] = `
<div> <div>
<button <button
class="btn btn-primary col-12 col-md-3 col-lg-2 d-inline-flex justify-content-center align-items-center" class="btn btn-primary col-sm-12 col-lg-3"
type="submit" type="submit"
> >
<span>
Save Save
</span>
</button> </button>
</div> </div>
`; `;
@ -35,18 +36,19 @@ exports[`<SubmitButton/> Render ready 1`] = `
exports[`<SubmitButton/> Render saving 1`] = ` exports[`<SubmitButton/> Render saving 1`] = `
<div> <div>
<button <button
class="btn btn-primary col-12 col-md-3 col-lg-2 d-inline-flex justify-content-center align-items-center" class="btn btn-primary col-sm-12 col-lg-3"
disabled="" disabled=""
type="submit" type="submit"
> >
<span <span
aria-hidden="true" aria-hidden="true"
class="spinner-border spinner-border-sm me-1" class="spinner-border spinner-border-sm"
role="status" role="status"
/> />
<span>
Updating Updating
</span>
</button> </button>
</div> </div>
`; `;

View File

@ -7,10 +7,12 @@
import React from "react"; import React from "react";
import { act, fireEvent, render, waitForElement } from "customTestRender"; import {
act, fireEvent, render, waitForElement,
} from "customTestRender";
import mockAxios from "jest-mock-axios"; import mockAxios from "jest-mock-axios";
import WebSockets from "webSockets/WebSockets"; import { WebSockets } from "webSockets/WebSockets";
import ForisForm from "../components/ForisForm"; import { ForisForm } from "../components/ForisForm";
// It's possible to unittest each hooks via react-hooks-testing-library. // It's possible to unittest each hooks via react-hooks-testing-library.
// But it's better and easier to test it by test components which uses this hooks. // But it's better and easier to test it by test components which uses this hooks.
@ -36,12 +38,8 @@ describe("useForm hook.", () => {
beforeEach(async () => { beforeEach(async () => {
mockPrepData = jest.fn(() => ({ field: "preparedData" })); mockPrepData = jest.fn(() => ({ field: "preparedData" }));
mockPrepDataToSubmit = jest.fn(() => ({ mockPrepDataToSubmit = jest.fn(() => ({ field: "preparedDataToSubmit" }));
field: "preparedDataToSubmit", mockValidator = jest.fn((data) => (data.field === "invalidValue" ? { field: "Error" } : {}));
}));
mockValidator = jest.fn((data) =>
data.field === "invalidValue" ? { field: "Error" } : {}
);
const { getByTestId, container } = render( const { getByTestId, container } = render(
<ForisForm <ForisForm
ws={new WebSockets()} ws={new WebSockets()}
@ -55,7 +53,7 @@ describe("useForm hook.", () => {
validator={mockValidator} validator={mockValidator}
> >
<Child /> <Child />
</ForisForm> </ForisForm>,
); );
mockAxios.mockResponse({ field: "fetchedData" }); mockAxios.mockResponse({ field: "fetchedData" });
@ -69,22 +67,16 @@ describe("useForm hook.", () => {
expect(Child.mock.calls[0][0].formErrors).toMatchObject({}); expect(Child.mock.calls[0][0].formErrors).toMatchObject({});
act(() => { act(() => {
fireEvent.change(input, { fireEvent.change(input, { target: { value: "invalidValue", type: "text" } });
target: { value: "invalidValue", type: "text" },
});
}); });
expect(Child).toHaveBeenCalledTimes(2); expect(Child).toHaveBeenCalledTimes(2);
expect(mockValidator).toHaveBeenCalledTimes(2); expect(mockValidator).toHaveBeenCalledTimes(2);
expect(Child.mock.calls[1][0].formErrors).toMatchObject({ expect(Child.mock.calls[1][0].formErrors).toMatchObject({ field: "Error" });
field: "Error",
});
}); });
it("Update text value.", () => { it("Update text value.", () => {
fireEvent.change(input, { fireEvent.change(input, { target: { value: "newValue", type: "text" } });
target: { value: "newValue", type: "text" },
});
expect(input.value).toBe("newValue"); expect(input.value).toBe("newValue");
}); });
@ -94,21 +86,14 @@ describe("useForm hook.", () => {
}); });
it("Update checkbox value.", () => { it("Update checkbox value.", () => {
fireEvent.change(input, { fireEvent.change(input, { target: { checked: true, type: "checkbox" } });
target: { checked: true, type: "checkbox" },
});
expect(input.checked).toBe(true); expect(input.checked).toBe(true);
}); });
it("Fetch data.", () => { it("Fetch data.", () => {
expect(mockAxios.get).toHaveBeenCalledWith( expect(mockAxios.get).toHaveBeenCalledWith("testEndpoint", expect.anything());
"testEndpoint",
expect.anything()
);
expect(mockPrepData).toHaveBeenCalledTimes(1); expect(mockPrepData).toHaveBeenCalledTimes(1);
expect(Child.mock.calls[0][0].formData).toMatchObject({ expect(Child.mock.calls[0][0].formData).toMatchObject({ field: "preparedData" });
field: "preparedData",
});
}); });
it("Submit.", () => { it("Submit.", () => {
@ -122,7 +107,7 @@ describe("useForm hook.", () => {
expect(mockAxios.post).toHaveBeenCalledWith( expect(mockAxios.post).toHaveBeenCalledWith(
"testEndpoint", "testEndpoint",
{ field: "preparedDataToSubmit" }, { field: "preparedDataToSubmit" },
expect.anything() expect.anything(),
); );
}); });
}); });

View File

@ -1,100 +1,135 @@
/* /*
* Copyright (C) 2019-2022 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import { import {
validateDomain,
validateDUID,
validateIPv4Address, validateIPv4Address,
validateIPv6Address, validateIPv6Address,
validateIPv6Prefix, validateIPv6Prefix,
validateDomain,
validateHostname,
validateDUID,
validateMAC, validateMAC,
} from "utils/validations"; } from "utils/validations";
describe("Validation functions", () => { describe("Validation functions", () => {
it("validateIPv4Address valid", () => { it("validateIPv4Address valid", () => {
expect(validateIPv4Address("192.168.1.1")).toBe(undefined); expect(validateIPv4Address("192.168.1.1"))
expect(validateIPv4Address("1.1.1.1")).toBe(undefined); .toBe(undefined);
expect(validateIPv4Address("0.0.0.0")).toBe(undefined); expect(validateIPv4Address("1.1.1.1"))
.toBe(undefined);
expect(validateIPv4Address("0.0.0.0"))
.toBe(undefined);
}); });
it("validateIPv4Address invalid", () => { it("validateIPv4Address invalid", () => {
expect(validateIPv4Address("invalid")).not.toBe(undefined); expect(validateIPv4Address("invalid"))
expect(validateIPv4Address("192.256.1.1")).not.toBe(undefined); .not
expect(validateIPv4Address("192.168.256.1")).not.toBe(undefined); .toBe(undefined);
expect(validateIPv4Address("192.168.1.256")).not.toBe(undefined); expect(validateIPv4Address("192.256.1.1"))
expect(validateIPv4Address("192.168.1.256")).not.toBe(undefined); .not
.toBe(undefined);
expect(validateIPv4Address("192.168.256.1"))
.not
.toBe(undefined);
expect(validateIPv4Address("192.168.1.256"))
.not
.toBe(undefined);
expect(validateIPv4Address("192.168.1.256"))
.not
.toBe(undefined);
}); });
it("validateIPv6Address valid", () => { it("validateIPv6Address valid", () => {
expect( expect(validateIPv6Address("2001:0db8:85a3:0000:0000:8a2e:0370:7334"))
validateIPv6Address("2001:0db8:85a3:0000:0000:8a2e:0370:7334") .toBe(undefined);
).toBe(undefined); expect(validateIPv6Address("0:0:0:0:0:0:0:1"))
expect(validateIPv6Address("0:0:0:0:0:0:0:1")).toBe(undefined); .toBe(undefined);
expect(validateIPv6Address("::1")).toBe(undefined); expect(validateIPv6Address("::1"))
expect(validateIPv6Address("::")).toBe(undefined); .toBe(undefined);
expect(validateIPv6Address("::"))
.toBe(undefined);
}); });
it("validateIPv6Address invalid", () => { it("validateIPv6Address invalid", () => {
expect(validateIPv6Address("invalid")).not.toBe(undefined); expect(validateIPv6Address("invalid"))
expect(validateIPv6Address("1.1.1.1")).not.toBe(undefined); .not
expect(validateIPv6Address("1200::AB00:1234::2552:7777:1313")).not.toBe( .toBe(undefined);
undefined expect(validateIPv6Address("1.1.1.1"))
); .not
expect( .toBe(undefined);
validateIPv6Address("1200:0000:AB00:1234:O000:2552:7777:1313") expect(validateIPv6Address("1200::AB00:1234::2552:7777:1313"))
).not.toBe(undefined); .not
.toBe(undefined);
expect(validateIPv6Address("1200:0000:AB00:1234:O000:2552:7777:1313"))
.not
.toBe(undefined);
}); });
it("validateIPv6Prefix valid", () => { it("validateIPv6Prefix valid", () => {
expect(validateIPv6Prefix("2002:0000::/16")).toBe(undefined); expect(validateIPv6Prefix("2002:0000::/16"))
expect(validateIPv6Prefix("0::/0")).toBe(undefined); .toBe(undefined);
expect(validateIPv6Prefix("0::/0"))
.toBe(undefined);
}); });
it("validateIPv6Prefix invalid", () => { it("validateIPv6Prefix invalid", () => {
expect( expect(validateIPv6Prefix("2001:0db8:85a3:0000:0000:8a2e:0370:7334"))
validateIPv6Prefix("2001:0db8:85a3:0000:0000:8a2e:0370:7334") .not
).not.toBe(undefined); .toBe(undefined);
expect(validateIPv6Prefix("::1")).not.toBe(undefined); expect(validateIPv6Prefix("::1"))
expect(validateIPv6Prefix("2002:0000::/999")).not.toBe(undefined); .not
.toBe(undefined);
expect(validateIPv6Prefix("2002:0000::/999"))
.not
.toBe(undefined);
}); });
it("validateDomain valid", () => { it("validateDomain valid", () => {
expect(validateDomain("example.com")).toBe(undefined); expect(validateDomain("example.com"))
expect(validateDomain("one.two.three")).toBe(undefined); .toBe(undefined);
expect(validateDomain("one.two.three"))
.toBe(undefined);
}); });
it("validateDomain invalid", () => { it("validateDomain invalid", () => {
expect(validateDomain("test/")).not.toBe(undefined); expect(validateDomain("test/"))
expect(validateDomain(".")).not.toBe(undefined); .not
}); .toBe(undefined);
expect(validateDomain("."))
it("validateHostname valid", () => { .not
expect(validateHostname("new-android")).toBe(undefined); .toBe(undefined);
expect(validateHostname("local")).toBe(undefined);
});
it("validateHostname invalid", () => {
expect(validateHostname("-android")).not.toBe(undefined);
expect(validateHostname("local.")).not.toBe(undefined);
}); });
it("validateDUID valid", () => { it("validateDUID valid", () => {
expect(validateDUID("abcdefAB")).toBe(undefined); expect(validateDUID("abcdefAB"))
expect(validateDUID("ABCDEF12")).toBe(undefined); .toBe(undefined);
expect(validateDUID("ABCDEF12AB")).toBe(undefined); expect(validateDUID("ABCDEF12"))
.toBe(undefined);
expect(validateDUID("ABCDEF12AB"))
.toBe(undefined);
}); });
it("validateDUID invalid", () => { it("validateDUID invalid", () => {
expect(validateDUID("gggggggg")).not.toBe(undefined); expect(validateDUID("gggggggg"))
expect(validateDUID("abcdefABa")).not.toBe(undefined); .not
.toBe(undefined);
expect(validateDUID("abcdefABa"))
.not
.toBe(undefined);
}); });
it("validateMAC valid", () => { it("validateMAC valid", () => {
expect(validateMAC("00:D0:56:F2:B5:12")).toBe(undefined); expect(validateMAC("00:D0:56:F2:B5:12"))
expect(validateMAC("00:26:DD:14:C4:EE")).toBe(undefined); .toBe(undefined);
expect(validateMAC("06:00:00:00:00:00")).toBe(undefined); expect(validateMAC("00:26:DD:14:C4:EE"))
.toBe(undefined);
expect(validateMAC("06:00:00:00:00:00"))
.toBe(undefined);
}); });
it("validateMAC invalid", () => { it("validateMAC invalid", () => {
expect(validateMAC("00:00:00:00:00:0G")).not.toBe(undefined); expect(validateMAC("00:00:00:00:00:0G"))
expect(validateMAC("06:00:00:00:00:00:00")).not.toBe(undefined); .not
.toBe(undefined);
expect(validateMAC("06:00:00:00:00:00:00"))
.not
.toBe(undefined);
}); });
}); });

View File

@ -1,24 +1,24 @@
/* /*
* Copyright (C) 2019-2024 CZ.NIC z.s.p.o. (https://www.nic.cz/) * Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
* *
* This is free software, licensed under the GNU General Public License v3. * This is free software, licensed under the GNU General Public License v3.
* See /LICENSE for more information. * See /LICENSE for more information.
*/ */
import React, { useEffect } from "react"; import React, { useEffect } from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import { Prompt } from "react-router-dom"; import { Prompt } from "react-router-dom";
import { STATES as SUBMIT_BUTTON_STATES, SubmitButton } from "./SubmitButton";
import { useAPIPost } from "../../api/hooks";
import { API_STATE } from "../../api/utils";
import { ALERT_TYPES } from "../../bootstrap/Alert"; import { ALERT_TYPES } from "../../bootstrap/Alert";
import { API_STATE } from "../../api/utils";
import { formFieldsSize } from "../../bootstrap/constants"; import { formFieldsSize } from "../../bootstrap/constants";
import { Spinner } from "../../bootstrap/Spinner"; import { Spinner } from "../../bootstrap/Spinner";
import { useAlert } from "../../context/alertContext/AlertContext"; import { useAlert } from "../../alertContext/AlertContext";
import ErrorMessage from "../../utils/ErrorMessage"; import { useAPIPost } from "../../api/hooks";
import { useForisModule, useForm } from "../hooks"; import { useForisModule, useForm } from "../hooks";
import { STATES as SUBMIT_BUTTON_STATES, SubmitButton } from "./SubmitButton";
import { ErrorMessage } from "../../utils/ErrorMessage";
ForisForm.propTypes = { ForisForm.propTypes = {
/** Optional WebSocket object. See `scr/common/WebSockets.js`. /** Optional WebSocket object. See `scr/common/WebSockets.js`.
@ -59,18 +59,12 @@ ForisForm.propTypes = {
// eslint-disable-next-line react/no-unused-prop-types // eslint-disable-next-line react/no-unused-prop-types
customWSProp(props) { customWSProp(props) {
const wsModuleIsSpecified = !!( const wsModuleIsSpecified = !!(props.forisConfig && props.forisConfig.wsModule);
props.forisConfig && props.forisConfig.wsModule
);
if (props.ws && !wsModuleIsSpecified) { if (props.ws && !wsModuleIsSpecified) {
return new Error( return new Error("forisConfig.wsModule should be specified when ws object is passed.");
"forisConfig.wsModule should be specified when ws object is passed."
);
} }
if (!props.ws && wsModuleIsSpecified) { if (!props.ws && wsModuleIsSpecified) {
return new Error( return new Error("forisConfig.wsModule is specified without passing ws object.");
"forisConfig.wsModule is specified without passing ws object."
);
} }
}, },
}; };
@ -89,7 +83,7 @@ ForisForm.defaultProps = {
* use exposed `ReactRouterDOM` object from `react-router-dom` library which is exposed by reForis. * use exposed `ReactRouterDOM` object from `react-router-dom` library which is exposed by reForis.
* See README for more information. * See README for more information.
* */ * */
function ForisForm({ export function ForisForm({
ws, ws,
forisConfig, forisConfig,
prepData, prepData,
@ -101,10 +95,7 @@ function ForisForm({
formReference, formReference,
children, children,
}) { }) {
const [formState, onFormChangeHandler, resetFormData] = useForm( const [formState, onFormChangeHandler, resetFormData] = useForm(validator, prepData);
validator,
prepData
);
const [setAlert, dismissAlert] = useAlert(); const [setAlert, dismissAlert] = useAlert();
const [forisModuleState] = useForisModule(ws, forisConfig); const [forisModuleState] = useForisModule(ws, forisConfig);
@ -131,16 +122,16 @@ function ForisForm({
return <Spinner />; return <Spinner />;
} }
const onSubmitHandler = (event) => { function onSubmitHandler(event) {
event.preventDefault(); event.preventDefault();
resetFormData(); resetFormData();
dismissAlert(); dismissAlert();
const copiedFormData = JSON.parse(JSON.stringify(formState.data)); const copiedFormData = JSON.parse(JSON.stringify(formState.data));
const preparedData = prepDataToSubmit(copiedFormData); const preparedData = prepDataToSubmit(copiedFormData);
post({ data: preparedData }); post({ data: preparedData });
}; }
const getSubmitButtonState = () => { function getSubmitButtonState() {
if (postState.state === API_STATE.SENDING) { if (postState.state === API_STATE.SENDING) {
return SUBMIT_BUTTON_STATES.SAVING; return SUBMIT_BUTTON_STATES.SAVING;
} }
@ -148,49 +139,39 @@ function ForisForm({
return SUBMIT_BUTTON_STATES.LOAD; return SUBMIT_BUTTON_STATES.LOAD;
} }
return SUBMIT_BUTTON_STATES.READY; return SUBMIT_BUTTON_STATES.READY;
}; }
const formIsDisabled = const formIsDisabled = (disabled
disabled || || forisModuleState.state === API_STATE.SENDING
forisModuleState.state === API_STATE.SENDING || || postState.state === API_STATE.SENDING);
postState.state === API_STATE.SENDING;
const submitButtonIsDisabled = disabled || !!formState.errors; const submitButtonIsDisabled = disabled || !!formState.errors;
const childrenWithFormProps = React.Children.map(children, (child) => const childrenWithFormProps = React.Children.map(
React.cloneElement(child, { children,
(child) => React.cloneElement(child, {
initialData: formState.initialData, initialData: formState.initialData,
formData: formState.data, formData: formState.data,
formErrors: formState.errors, formErrors: formState.errors,
setFormValue: onFormChangeHandler, setFormValue: onFormChangeHandler,
disabled: formIsDisabled, disabled: formIsDisabled,
}) }),
); );
const onSubmit = onSubmitOverridden const onSubmit = onSubmitOverridden
? onSubmitOverridden( ? onSubmitOverridden(formState.data, onFormChangeHandler, onSubmitHandler)
formState.data,
onFormChangeHandler,
onSubmitHandler
)
: onSubmitHandler; : onSubmitHandler;
const getMessageOnLeavingPage = () => { function getMessageOnLeavingPage() {
if ( if (JSON.stringify(formState.data) === JSON.stringify(formState.initialData)) return true;
JSON.stringify(formState.data) === return _("Changes you made may not be saved. Are you sure you want to leave?");
JSON.stringify(formState.initialData) }
)
return true;
return _(
"Changes you made may not be saved. Are you sure you want to leave?"
);
};
return ( return (
<div className={formFieldsSize}> <div className={formFieldsSize}>
<Prompt message={getMessageOnLeavingPage} /> <Prompt message={getMessageOnLeavingPage} />
<form onSubmit={onSubmit} ref={formReference}> <form onSubmit={onSubmit} ref={formReference}>
{childrenWithFormProps} {childrenWithFormProps}
<div className="text-end"> <div className="text-right">
<SubmitButton <SubmitButton
state={getSubmitButtonState()} state={getSubmitButtonState()}
disabled={submitButtonIsDisabled} disabled={submitButtonIsDisabled}
@ -200,5 +181,3 @@ function ForisForm({
</div> </div>
); );
} }
export default ForisForm;

View File

@ -1,11 +1,8 @@
`<ForisForm/>` is Higher-Order Component which encapsulates entire form logic `<ForisForm/>` is Higher-Order Component which encapsulates entire form logic and provides with children required props.
and provides with children required props. This component structure provides This component structure provides comfort API and allows to create typical Foris module forms easily.
comfort API and allows to create typical Foris module forms easily.
## Example of usage of `<ForisForm/>` ## Example of usage of `<ForisForm/>`
You can pass more forms as children. You can pass more forms as children.
```js ```js
<ForisForm <ForisForm
ws={ws} ws={ws}
@ -27,10 +24,7 @@ You can pass more forms as children.
```js ```js
export default function MACForm({ export default function MACForm({
formData, formData, formErrors, setFormValue, ...props
formErrors,
setFormValue,
...props
}) { }) {
const macSettings = formData.mac_settings; const macSettings = formData.mac_settings;
const errors = (formErrors || {}).mac_settings || {}; const errors = (formErrors || {}).mac_settings || {};
@ -41,33 +35,38 @@ export default function MACForm({
label={_("Custom MAC address")} label={_("Custom MAC address")}
checked={macSettings.custom_mac_enabled} checked={macSettings.custom_mac_enabled}
helpText={HELP_TEXTS.custom_mac_enabled} helpText={HELP_TEXTS.custom_mac_enabled}
onChange={setFormValue((value) => ({
mac_settings: { custom_mac_enabled: { $set: value } }, onChange={setFormValue(
}))} (value) => ({ mac_settings: { custom_mac_enabled: { $set: value } } }),
)}
{...props} {...props}
/> />
{macSettings.custom_mac_enabled ? ( {macSettings.custom_mac_enabled
? (
<TextInput <TextInput
label={_("MAC address")} label={_("MAC address")}
value={macSettings.custom_mac || ""} value={macSettings.custom_mac || ""}
helpText={HELP_TEXTS.custom_mac} helpText={HELP_TEXTS.custom_mac}
error={errors.custom_mac} error={errors.custom_mac}
required required
onChange={setFormValue((value) => ({
mac_settings: { custom_mac: { $set: value } }, onChange={setFormValue(
}))} (value) => ({ mac_settings: { custom_mac: { $set: value } } }),
)}
{...props} {...props}
/> />
) : null} )
: null}
</> </>
); );
} }
``` ```
The <ForisForm/> passes subsequent `props` to the child components. The <ForisForm/> passes subsequent `props` to the child components.
| Prop | Type | Description | | Prop | Type | Description |
| -------------- | ------ | -------------------------------------------------------------------------- | |----------------|--------|----------------------------------------------------------------------------|
| `formData` | object | Data returned from API. | | `formData` | object | Data returned from API. |
| `formErrors` | object | Errors returned after validation via validator. | | `formErrors` | object | Errors returned after validation via validator. |
| `setFormValue` | func | Function for data update. It takes update rule as arg (see example above). | | `setFormValue` | func | Function for data update. It takes update rule as arg (see example above). |

View File

@ -6,10 +6,9 @@
*/ */
import React from "react"; import React from "react";
import PropTypes from "prop-types"; import PropTypes from "prop-types";
import Button from "../../bootstrap/Button"; import { Button } from "../../bootstrap/Button";
export const STATES = { export const STATES = {
READY: 1, READY: 1,
@ -19,7 +18,8 @@ export const STATES = {
SubmitButton.propTypes = { SubmitButton.propTypes = {
disabled: PropTypes.bool, disabled: PropTypes.bool,
state: PropTypes.oneOf(Object.keys(STATES).map((key) => STATES[key])), state: PropTypes.oneOf(Object.keys(STATES)
.map((key) => STATES[key])),
}; };
export function SubmitButton({ disabled, state, ...props }) { export function SubmitButton({ disabled, state, ...props }) {
@ -44,6 +44,7 @@ export function SubmitButton({ disabled, state, ...props }) {
loading={loadingSubmitButton} loading={loadingSubmitButton}
disabled={disableSubmitButton} disabled={disableSubmitButton}
forisFormSize forisFormSize
{...props} {...props}
> >
{labelSubmitButton} {labelSubmitButton}

Some files were not shown because too many files have changed in this diff Show More