Compare commits
No commits in common. "develop" and "v1.0.1" have entirely different histories.
@ -1 +0,0 @@
|
|||||||
{ "extends": ["@commitlint/config-conventional"] }
|
|
||||||
@ -1,11 +1,9 @@
|
|||||||
# https://editorconfig.org/
|
|
||||||
|
|
||||||
root = true
|
root = true
|
||||||
|
|
||||||
[*]
|
[*]
|
||||||
|
charset = utf-8
|
||||||
indent_style = space
|
indent_style = space
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
end_of_line = lf
|
end_of_line = lf
|
||||||
charset = utf-8
|
|
||||||
trim_trailing_whitespace = true
|
|
||||||
insert_final_newline = true
|
insert_final_newline = true
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
|||||||
5
.eslintignore
Normal file
5
.eslintignore
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
build/
|
||||||
|
dist/
|
||||||
|
node_modules/
|
||||||
|
.snapshots/
|
||||||
|
*.min.js
|
||||||
34
.eslintrc
Normal file
34
.eslintrc
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
{
|
||||||
|
"parser": "@typescript-eslint/parser",
|
||||||
|
"extends": [
|
||||||
|
"standard",
|
||||||
|
"standard-react",
|
||||||
|
"plugin:prettier/recommended",
|
||||||
|
"prettier/standard",
|
||||||
|
"prettier/react",
|
||||||
|
"plugin:@typescript-eslint/eslint-recommended"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"node": true
|
||||||
|
},
|
||||||
|
"parserOptions": {
|
||||||
|
"ecmaVersion": 2020,
|
||||||
|
"ecmaFeatures": {
|
||||||
|
"legacyDecorators": true,
|
||||||
|
"jsx": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"settings": {
|
||||||
|
"react": {
|
||||||
|
"version": "16"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rules": {
|
||||||
|
"space-before-function-paren": 0,
|
||||||
|
"react/prop-types": 0,
|
||||||
|
"react/jsx-handler-names": 0,
|
||||||
|
"react/jsx-fragments": 0,
|
||||||
|
"react/no-unused-prop-types": 0,
|
||||||
|
"import/export": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,16 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": ["conventions", "prettier"],
|
|
||||||
"ignorePatterns": ["tsup.config.js", "example"],
|
|
||||||
"plugins": ["prettier", "import", "unicorn"],
|
|
||||||
"parser": "@typescript-eslint/parser",
|
|
||||||
"parserOptions": {
|
|
||||||
"project": "./tsconfig.json"
|
|
||||||
},
|
|
||||||
"env": {
|
|
||||||
"jest": true,
|
|
||||||
"browser": true
|
|
||||||
},
|
|
||||||
"rules": {
|
|
||||||
"prettier/prettier": "error"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
1
.gitattributes
vendored
1
.gitattributes
vendored
@ -1 +0,0 @@
|
|||||||
* text=auto eol=lf
|
|
||||||
20
.github/ISSUE_TEMPLATE/BUG.md
vendored
20
.github/ISSUE_TEMPLATE/BUG.md
vendored
@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
name: "🐛 Bug Report"
|
|
||||||
about: "Report an unexpected problem or unintended behavior."
|
|
||||||
title: "[Bug]"
|
|
||||||
labels: "bug"
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Please provide a clear and concise description of what the bug is. Include
|
|
||||||
screenshots if needed. Please make sure your issue has not already been fixed.
|
|
||||||
-->
|
|
||||||
|
|
||||||
## Steps To Reproduce
|
|
||||||
|
|
||||||
1. Step 1
|
|
||||||
2. Step 2
|
|
||||||
|
|
||||||
## The current behavior
|
|
||||||
|
|
||||||
## The expected behavior
|
|
||||||
18
.github/ISSUE_TEMPLATE/DOCUMENTATION.md
vendored
18
.github/ISSUE_TEMPLATE/DOCUMENTATION.md
vendored
@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
name: "📜 Documentation"
|
|
||||||
about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
|
|
||||||
title: "[Documentation]"
|
|
||||||
labels: "documentation"
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- Please make sure your issue has not already been fixed. -->
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
<!-- Please uncomment the type of documentation problem this issue address -->
|
|
||||||
|
|
||||||
<!-- Documentation is Missing -->
|
|
||||||
<!-- Documentation is Confusing -->
|
|
||||||
<!-- Documentation has Typo errors -->
|
|
||||||
|
|
||||||
## Proposal
|
|
||||||
20
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
20
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
name: "✨ Feature Request"
|
|
||||||
about: "Suggest a new feature idea."
|
|
||||||
title: "[Feature]"
|
|
||||||
labels: "feature request"
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- Please make sure your issue has not already been fixed. -->
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
<!-- A clear and concise description of the problem or missing capability... -->
|
|
||||||
|
|
||||||
## Describe the solution you'd like
|
|
||||||
|
|
||||||
<!-- If you have a solution in mind, please describe it. -->
|
|
||||||
|
|
||||||
## Describe alternatives you've considered
|
|
||||||
|
|
||||||
<!-- Have you considered any alternative solutions or workarounds? -->
|
|
||||||
20
.github/ISSUE_TEMPLATE/IMPROVEMENT.md
vendored
20
.github/ISSUE_TEMPLATE/IMPROVEMENT.md
vendored
@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
name: "🔧 Improvement"
|
|
||||||
about: "Improve structure/format/performance/refactor/tests of the code."
|
|
||||||
title: "[Improvement]"
|
|
||||||
labels: "improvement"
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- Please make sure your issue has not already been fixed. -->
|
|
||||||
|
|
||||||
## Type of Improvement
|
|
||||||
|
|
||||||
<!-- Please uncomment the type of improvements this issue address -->
|
|
||||||
|
|
||||||
<!-- Files and Folders Structure -->
|
|
||||||
<!-- Performance -->
|
|
||||||
<!-- Refactoring code -->
|
|
||||||
<!-- Tests -->
|
|
||||||
<!-- Not Sure? -->
|
|
||||||
|
|
||||||
## Proposal
|
|
||||||
8
.github/ISSUE_TEMPLATE/QUESTION.md
vendored
8
.github/ISSUE_TEMPLATE/QUESTION.md
vendored
@ -1,8 +0,0 @@
|
|||||||
---
|
|
||||||
name: "🙋 Question"
|
|
||||||
about: "Further information is requested."
|
|
||||||
title: "[Question]"
|
|
||||||
labels: "question"
|
|
||||||
---
|
|
||||||
|
|
||||||
### Question
|
|
||||||
7
.github/PULL_REQUEST_TEMPLATE.md
vendored
7
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,7 +0,0 @@
|
|||||||
<!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
|
|
||||||
|
|
||||||
# What changes this PR introduce?
|
|
||||||
|
|
||||||
## List any relevant issue numbers
|
|
||||||
|
|
||||||
## Is there anything you'd like reviewers to focus on?
|
|
||||||
28
.github/workflows/build.yml
vendored
28
.github/workflows/build.yml
vendored
@ -1,28 +0,0 @@
|
|||||||
name: "Build"
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [develop]
|
|
||||||
pull_request:
|
|
||||||
branches: [master, develop]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: "ubuntu-latest"
|
|
||||||
steps:
|
|
||||||
- uses: "actions/checkout@v4.1.1"
|
|
||||||
|
|
||||||
- name: "Setup Node.js"
|
|
||||||
uses: "actions/setup-node@v4.0.1"
|
|
||||||
with:
|
|
||||||
node-version: "lts/*"
|
|
||||||
cache: "npm"
|
|
||||||
|
|
||||||
- name: "Install dependencies"
|
|
||||||
run: "npm clean-install"
|
|
||||||
|
|
||||||
- name: "Build Package"
|
|
||||||
run: "npm run build"
|
|
||||||
|
|
||||||
- name: "Build Example"
|
|
||||||
run: "cd example && npm clean-install && npm run build"
|
|
||||||
28
.github/workflows/lint.yml
vendored
28
.github/workflows/lint.yml
vendored
@ -1,28 +0,0 @@
|
|||||||
name: "Lint"
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [develop]
|
|
||||||
pull_request:
|
|
||||||
branches: [master, develop]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
lint:
|
|
||||||
runs-on: "ubuntu-latest"
|
|
||||||
steps:
|
|
||||||
- uses: "actions/checkout@v4.1.1"
|
|
||||||
|
|
||||||
- name: "Setup Node.js"
|
|
||||||
uses: "actions/setup-node@v4.0.1"
|
|
||||||
with:
|
|
||||||
node-version: "lts/*"
|
|
||||||
cache: "npm"
|
|
||||||
|
|
||||||
- name: "Install dependencies"
|
|
||||||
run: "npm clean-install"
|
|
||||||
|
|
||||||
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
|
|
||||||
- run: "npm run lint:editorconfig"
|
|
||||||
- run: "npm run lint:markdown"
|
|
||||||
- run: "npm run lint:eslint"
|
|
||||||
- run: "npm run lint:prettier"
|
|
||||||
25
.github/workflows/node.js.yml
vendored
Normal file
25
.github/workflows/node.js.yml
vendored
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
name: Node.js CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [master]
|
||||||
|
pull_request:
|
||||||
|
branches: [master]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
node-version: [10.x, 12.x, 14.x]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node-version }}
|
||||||
|
- run: npm ci
|
||||||
|
- run: npm run test:build
|
||||||
|
- run: npm run test:lint
|
||||||
37
.github/workflows/release.yml
vendored
37
.github/workflows/release.yml
vendored
@ -1,37 +0,0 @@
|
|||||||
name: "Release"
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [master]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: "ubuntu-latest"
|
|
||||||
permissions:
|
|
||||||
contents: "write"
|
|
||||||
issues: "write"
|
|
||||||
pull-requests: "write"
|
|
||||||
id-token: "write"
|
|
||||||
steps:
|
|
||||||
- uses: "actions/checkout@v4.1.1"
|
|
||||||
|
|
||||||
- name: "Setup Node.js"
|
|
||||||
uses: "actions/setup-node@v4.0.1"
|
|
||||||
with:
|
|
||||||
node-version: "lts/*"
|
|
||||||
cache: "npm"
|
|
||||||
|
|
||||||
- name: "Install dependencies"
|
|
||||||
run: "npm clean-install"
|
|
||||||
|
|
||||||
- name: "Build Package"
|
|
||||||
run: "npm run build"
|
|
||||||
|
|
||||||
- name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
|
|
||||||
run: "npm audit signatures"
|
|
||||||
|
|
||||||
- name: "Release"
|
|
||||||
run: "npm run release"
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
48
.github/workflows/test.yml
vendored
48
.github/workflows/test.yml
vendored
@ -1,48 +0,0 @@
|
|||||||
name: "Test"
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [develop]
|
|
||||||
pull_request:
|
|
||||||
branches: [master, develop]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: "ubuntu-latest"
|
|
||||||
steps:
|
|
||||||
- uses: "actions/checkout@v4.1.1"
|
|
||||||
|
|
||||||
- name: "Setup Node.js"
|
|
||||||
uses: "actions/setup-node@v4.0.1"
|
|
||||||
with:
|
|
||||||
node-version: "lts/*"
|
|
||||||
cache: "npm"
|
|
||||||
|
|
||||||
- name: "Install dependencies"
|
|
||||||
run: "npm clean-install"
|
|
||||||
|
|
||||||
- name: "Test"
|
|
||||||
run: "npm run test"
|
|
||||||
|
|
||||||
test-e2e:
|
|
||||||
runs-on: "ubuntu-latest"
|
|
||||||
steps:
|
|
||||||
- uses: "actions/checkout@v4.1.1"
|
|
||||||
|
|
||||||
- name: "Setup Node.js"
|
|
||||||
uses: "actions/setup-node@v4.0.1"
|
|
||||||
with:
|
|
||||||
node-version: "lts/*"
|
|
||||||
cache: "npm"
|
|
||||||
|
|
||||||
- name: "Install dependencies"
|
|
||||||
run: "npm clean-install"
|
|
||||||
|
|
||||||
- name: "Build Package"
|
|
||||||
run: "npm run build"
|
|
||||||
|
|
||||||
- name: "Build Example"
|
|
||||||
run: "cd example && npm clean-install && npm run build"
|
|
||||||
|
|
||||||
- name: "End To End (e2e) Test Example"
|
|
||||||
run: "cd example && npm run test:e2e"
|
|
||||||
45
.gitignore
vendored
45
.gitignore
vendored
@ -1,40 +1,21 @@
|
|||||||
|
# See https://help.github.com/ignore-files/ for more about ignoring files.
|
||||||
|
|
||||||
# dependencies
|
# dependencies
|
||||||
node_modules
|
node_modules
|
||||||
.npm
|
|
||||||
|
|
||||||
# production
|
# builds
|
||||||
build
|
build
|
||||||
dist
|
dist
|
||||||
.next
|
.rpt2_cache
|
||||||
|
|
||||||
# testing
|
|
||||||
coverage
|
|
||||||
.nyc_output
|
|
||||||
|
|
||||||
# envs
|
|
||||||
.env
|
|
||||||
.env.production
|
|
||||||
|
|
||||||
# debug
|
|
||||||
npm-debug.log*
|
|
||||||
|
|
||||||
# IDEs and editors
|
|
||||||
/.idea
|
|
||||||
.project
|
|
||||||
.classpath
|
|
||||||
.c9/
|
|
||||||
*.launch
|
|
||||||
.settings/
|
|
||||||
*.sublime-workspace
|
|
||||||
|
|
||||||
# IDE - VSCode
|
|
||||||
.vscode/*
|
|
||||||
!.vscode/settings.json
|
|
||||||
!.vscode/tasks.json
|
|
||||||
!.vscode/launch.json
|
|
||||||
!.vscode/extensions.json
|
|
||||||
|
|
||||||
# misc
|
# misc
|
||||||
.DS_Store
|
.DS_Store
|
||||||
.parcel-cache
|
.env
|
||||||
.cache
|
.env.local
|
||||||
|
.env.development.local
|
||||||
|
.env.test.local
|
||||||
|
.env.production.local
|
||||||
|
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
|||||||
@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"config": {
|
|
||||||
"extends": "markdownlint/style/prettier",
|
|
||||||
"default": true,
|
|
||||||
"relative-links": true,
|
|
||||||
"no-inline-html": false,
|
|
||||||
},
|
|
||||||
"globs": ["**/*.md"],
|
|
||||||
"ignores": ["**/node_modules"],
|
|
||||||
"customRules": ["markdownlint-rule-relative-links"],
|
|
||||||
}
|
|
||||||
10
.prettierrc
Normal file
10
.prettierrc
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"singleQuote": true,
|
||||||
|
"jsxSingleQuote": true,
|
||||||
|
"semi": false,
|
||||||
|
"tabWidth": 2,
|
||||||
|
"bracketSpacing": true,
|
||||||
|
"jsxBracketSameLine": false,
|
||||||
|
"arrowParens": "always",
|
||||||
|
"trailingComma": "none"
|
||||||
|
}
|
||||||
@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"semi": false
|
|
||||||
}
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
{
|
|
||||||
"branches": ["master"],
|
|
||||||
"plugins": [
|
|
||||||
[
|
|
||||||
"@semantic-release/commit-analyzer",
|
|
||||||
{
|
|
||||||
"preset": "conventionalcommits"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
[
|
|
||||||
"@semantic-release/release-notes-generator",
|
|
||||||
{
|
|
||||||
"preset": "conventionalcommits"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"@semantic-release/npm",
|
|
||||||
"@semantic-release/github"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
4
.travis.yml
Normal file
4
.travis.yml
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
language: node_js
|
||||||
|
node_js:
|
||||||
|
- 12
|
||||||
|
- 10
|
||||||
@ -1,132 +0,0 @@
|
|||||||
# Contributor Covenant Code of Conduct
|
|
||||||
|
|
||||||
## Our Pledge
|
|
||||||
|
|
||||||
We as members, contributors, and leaders pledge to make participation in our
|
|
||||||
community a harassment-free experience for everyone, regardless of age, body
|
|
||||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
||||||
identity and expression, level of experience, education, socio-economic status,
|
|
||||||
nationality, personal appearance, race, religion, or sexual identity
|
|
||||||
and orientation.
|
|
||||||
|
|
||||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
||||||
diverse, inclusive, and healthy community.
|
|
||||||
|
|
||||||
## Our Standards
|
|
||||||
|
|
||||||
Examples of behavior that contributes to a positive environment for our
|
|
||||||
community include:
|
|
||||||
|
|
||||||
- Demonstrating empathy and kindness toward other people
|
|
||||||
- Being respectful of differing opinions, viewpoints, and experiences
|
|
||||||
- Giving and gracefully accepting constructive feedback
|
|
||||||
- Accepting responsibility and apologizing to those affected by our mistakes,
|
|
||||||
and learning from the experience
|
|
||||||
- Focusing on what is best not just for us as individuals, but for the
|
|
||||||
overall community
|
|
||||||
|
|
||||||
Examples of unacceptable behavior include:
|
|
||||||
|
|
||||||
- The use of sexualized language or imagery, and sexual attention or
|
|
||||||
advances of any kind
|
|
||||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
||||||
- Public or private harassment
|
|
||||||
- Publishing others' private information, such as a physical or email
|
|
||||||
address, without their explicit permission
|
|
||||||
- Other conduct which could reasonably be considered inappropriate in a
|
|
||||||
professional setting
|
|
||||||
|
|
||||||
## Enforcement Responsibilities
|
|
||||||
|
|
||||||
Community leaders are responsible for clarifying and enforcing our standards of
|
|
||||||
acceptable behavior and will take appropriate and fair corrective action in
|
|
||||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
||||||
or harmful.
|
|
||||||
|
|
||||||
Community leaders have the right and responsibility to remove, edit, or reject
|
|
||||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
||||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
||||||
decisions when appropriate.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This Code of Conduct applies within all community spaces, and also applies when
|
|
||||||
an individual is officially representing the community in public spaces.
|
|
||||||
Examples of representing our community include using an official e-mail address,
|
|
||||||
posting via an official social media account, or acting as an appointed
|
|
||||||
representative at an online or offline event.
|
|
||||||
|
|
||||||
## Enforcement
|
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
||||||
reported to the community leaders responsible for enforcement at
|
|
||||||
<contact@theoludwig.fr>.
|
|
||||||
All complaints will be reviewed and investigated promptly and fairly.
|
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the
|
|
||||||
reporter of any incident.
|
|
||||||
|
|
||||||
## Enforcement Guidelines
|
|
||||||
|
|
||||||
Community leaders will follow these Community Impact Guidelines in determining
|
|
||||||
the consequences for any action they deem in violation of this Code of Conduct:
|
|
||||||
|
|
||||||
### 1. Correction
|
|
||||||
|
|
||||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
||||||
unprofessional or unwelcome in the community.
|
|
||||||
|
|
||||||
**Consequence**: A private, written warning from community leaders, providing
|
|
||||||
clarity around the nature of the violation and an explanation of why the
|
|
||||||
behavior was inappropriate. A public apology may be requested.
|
|
||||||
|
|
||||||
### 2. Warning
|
|
||||||
|
|
||||||
**Community Impact**: A violation through a single incident or series
|
|
||||||
of actions.
|
|
||||||
|
|
||||||
**Consequence**: A warning with consequences for continued behavior. No
|
|
||||||
interaction with the people involved, including unsolicited interaction with
|
|
||||||
those enforcing the Code of Conduct, for a specified period of time. This
|
|
||||||
includes avoiding interactions in community spaces as well as external channels
|
|
||||||
like social media. Violating these terms may lead to a temporary or
|
|
||||||
permanent ban.
|
|
||||||
|
|
||||||
### 3. Temporary Ban
|
|
||||||
|
|
||||||
**Community Impact**: A serious violation of community standards, including
|
|
||||||
sustained inappropriate behavior.
|
|
||||||
|
|
||||||
**Consequence**: A temporary ban from any sort of interaction or public
|
|
||||||
communication with the community for a specified period of time. No public or
|
|
||||||
private interaction with the people involved, including unsolicited interaction
|
|
||||||
with those enforcing the Code of Conduct, is allowed during this period.
|
|
||||||
Violating these terms may lead to a permanent ban.
|
|
||||||
|
|
||||||
### 4. Permanent Ban
|
|
||||||
|
|
||||||
**Community Impact**: Demonstrating a pattern of violation of community
|
|
||||||
standards, including sustained inappropriate behavior, harassment of an
|
|
||||||
individual, or aggression toward or disparagement of classes of individuals.
|
|
||||||
|
|
||||||
**Consequence**: A permanent ban from any sort of public interaction within
|
|
||||||
the community.
|
|
||||||
|
|
||||||
## Attribution
|
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
||||||
version 2.0, available at
|
|
||||||
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
|
||||||
|
|
||||||
Community Impact Guidelines were inspired by
|
|
||||||
[Mozilla's code of conduct enforcement ladder][mozilla coc].
|
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see the FAQ at
|
|
||||||
[https://www.contributor-covenant.org/faq][faq]. Translations are available
|
|
||||||
at [https://www.contributor-covenant.org/translations][translations].
|
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
|
||||||
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
|
||||||
[mozilla coc]: https://github.com/mozilla/diversity
|
|
||||||
[faq]: https://www.contributor-covenant.org/faq
|
|
||||||
[translations]: https://www.contributor-covenant.org/translations
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
# 💡 Contributing
|
|
||||||
|
|
||||||
Thanks a lot for your interest in contributing to **react-component-form**! 🎉
|
|
||||||
|
|
||||||
## Code of Conduct
|
|
||||||
|
|
||||||
**react-component-form** has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
|
|
||||||
|
|
||||||
## Open Development
|
|
||||||
|
|
||||||
All work on **react-component-form** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
|
|
||||||
|
|
||||||
## Types of contributions
|
|
||||||
|
|
||||||
- Reporting a bug.
|
|
||||||
- Suggest a new feature idea.
|
|
||||||
- Correct spelling errors, improvements or additions to documentation files.
|
|
||||||
- Improve structure/format/performance/refactor/tests of the code.
|
|
||||||
|
|
||||||
## Pull Requests
|
|
||||||
|
|
||||||
- **Please first discuss** the change you wish to make via issues.
|
|
||||||
|
|
||||||
- Ensure your code respect linting.
|
|
||||||
|
|
||||||
- Make sure your **code passes the tests**.
|
|
||||||
|
|
||||||
If you're adding new features to **react-component-form**, please include tests.
|
|
||||||
|
|
||||||
## Commits
|
|
||||||
|
|
||||||
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
|
|
||||||
23
LICENSE
23
LICENSE
@ -1,21 +1,8 @@
|
|||||||
# MIT License
|
The MIT License (MIT)
|
||||||
|
Copyright © 2020 Divlo
|
||||||
|
|
||||||
Copyright (c) Théo LUDWIG <contact@theoludwig.fr>
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
120
README.md
120
README.md
@ -5,47 +5,32 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<strong>⚠️ This project is not maintained anymore, you can still use the code as you wish and fork it to maintain it yourself.</strong>
|
<a href="https://gitmoji.carloscuesta.me/"><img src="https://camo.githubusercontent.com/2a4924a23bd9ef18afe793f4999b1b9ec474e48f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6769746d6f6a692d253230f09f989c253230f09f988d2d4646444436372e7376673f7374796c653d666c61742d737175617265" alt="Gitmoji"/></a>
|
||||||
</p>
|
<a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"/></a>
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="CONTRIBUTING /></a>
|
|
||||||
<a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
|
<a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
|
||||||
<a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
|
|
||||||
<br />
|
|
||||||
<a href="https://github.com/theoludwig/react-component-form/actions/workflows/build.yml"><img src="https://github.com/theoludwig/react-component-form/actions/workflows/build.yml/badge.svg?branch=develop" alt="Build" /></a>
|
|
||||||
<a href="https://github.com/theoludwig/react-component-form/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/react-component-form/actions/workflows/lint.yml/badge.svg?branch=develop" alt="Lint" /></a>
|
|
||||||
<a href="https://github.com/theoludwig/react-component-form/actions/workflows/test.yml"><img src="https://github.com/theoludwig/react-component-form/actions/workflows/test.yml/badge.svg?branch=develop" alt="Test" /></a>
|
|
||||||
<br />
|
|
||||||
<a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
|
|
||||||
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
|
|
||||||
<a href="https://www.npmjs.com/package/react-component-form"><img src="https://img.shields.io/npm/v/react-component-form.svg" alt="npm version"></a>
|
<a href="https://www.npmjs.com/package/react-component-form"><img src="https://img.shields.io/npm/v/react-component-form.svg" alt="npm version"></a>
|
||||||
|
<img src="https://github.com/Divlo/react-component-form/workflows/Node.js%20CI/badge.svg" alt="Node.js CI" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 📜 About
|
## 📜 About
|
||||||
|
|
||||||
**react-component-form** is a lightweight form component for [React.js](https://reactjs.org/), it allows you to get the inputs values without state thanks to `onChange` or `onSubmit` props.
|
**react-component-form** is a lightweight form component for [React.js](https://reactjs.org/), it allows you to get the inputs values without state thanks to `onChange` or `onSubmit` props.
|
||||||
|
|
||||||
There is also a [React Hooks](https://reactjs.org/docs/hooks-intro.html) to be used in combination with the `<Form />` component to validate the data with [Ajv JSON schema validator](https://ajv.js.org/), see [advanced usage](#%EF%B8%8F-advanced-usage).
|
Demo : [https://divlo.github.io/react-component-form/](https://divlo.github.io/react-component-form/).
|
||||||
|
|
||||||
Example demo: [https://react-component-form.vercel.app/](https://react-component-form.vercel.app/).
|
|
||||||
|
|
||||||
## 💾 Install
|
## 💾 Install
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
npm install --save react-component-form
|
npm install --save react-component-form
|
||||||
```
|
```
|
||||||
|
|
||||||
## ⚙️ Usage
|
## ⚙️ Usage
|
||||||
|
|
||||||
_Note: The examples use TypeScript, but obviously you can use JavaScript. Be aware that `HandleForm` is the type definition for the `onChange` and `onSubmit` props._
|
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
import React from "react"
|
import React from 'react'
|
||||||
import { Form } from "react-component-form"
|
import Form, { HandleForm } from 'react-component-form'
|
||||||
import type { HandleForm } from "react-component-form"
|
|
||||||
|
|
||||||
export const Example = () => {
|
const Example = () => {
|
||||||
const handleSubmit: HandleForm = (formData, formElement) => {
|
const handleSubmit: HandleForm = (formData, formElement) => {
|
||||||
console.log(formData) // { inputName: 'value of the input' }
|
console.log(formData) // { inputName: 'value of the input' }
|
||||||
formElement.reset()
|
formElement.reset()
|
||||||
@ -53,96 +38,21 @@ export const Example = () => {
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<Form onSubmit={handleSubmit}>
|
<Form onSubmit={handleSubmit}>
|
||||||
<input type="text" name="inputName" />
|
<input type='text' name='inputName' />
|
||||||
<button type="submit">Submit</button>
|
<button type='submit'>Submit</button>
|
||||||
</Form>
|
</Form>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Basically you have access to the same props of the HTML `form` tag in React, but the `onSubmit` and the `onChange` props are differents.
|
_Note : The example use TypeScript, but obviously you can use JavaScript. Be aware that `HandleForm` is the type definition for the `onChange` and `onSubmit` props._
|
||||||
|
|
||||||
Instead to get the `event` param you get `formData` and `formElement` parameters:
|
Basically you have access to the same props of the HTML `form` tag in React, but the onSubmit and the onChange props are differents.
|
||||||
|
|
||||||
- `formData`: Object where the keys are the name of your inputs and the current value. Behind the scene, it uses the [FormData](https://developer.mozilla.org/docs/Web/API/FormData) constructor.
|
Instead to get the `event` param you get `formData` and `formElement` params :
|
||||||
- `formElement`: The HTML form element in the DOM so for example you can access the `.reset()` method on a [HTMLFormElement](https://developer.mozilla.org/docs/Web/API/HTMLFormElement).
|
|
||||||
|
|
||||||
## ⚙️ Advanced Usage
|
- `formData`: It's an object where the keys are the name of your inputs and the current value. Behind the scene, it uses the [FormData](https://developer.mozilla.org/docs/Web/API/FormData) constructor.
|
||||||
|
- `formElement`: It's the actual HTML form element in the DOM so for example you can access the `.reset()` method on a [HTMLFormElement](https://developer.mozilla.org/docs/Web/API/HTMLFormElement).
|
||||||
This example shows how to use the `<Form />` component with `useForm` hook to validate the data with [Ajv JSON schema validator](https://ajv.js.org/).
|
|
||||||
|
|
||||||
You can see a more detailled example in the [./example](./example) folder.
|
|
||||||
|
|
||||||
```tsx
|
|
||||||
import React from "react"
|
|
||||||
import { Form, useForm } from "react-component-form"
|
|
||||||
import type { HandleUseFormCallback } from "react-component-form"
|
|
||||||
|
|
||||||
const schema = {
|
|
||||||
inputName: {
|
|
||||||
type: "string",
|
|
||||||
minLength: 3,
|
|
||||||
maxLength: 20,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
export const Example = () => {
|
|
||||||
const { handleUseForm, errors, message } = useForm(schema)
|
|
||||||
|
|
||||||
const onSubmit: HandleUseFormCallback<typeof schema> = (
|
|
||||||
formData,
|
|
||||||
formElement,
|
|
||||||
) => {
|
|
||||||
console.log(formData) // { inputName: 'value of the input validated and type-safe' }
|
|
||||||
formElement.reset()
|
|
||||||
|
|
||||||
// The return can be either `null` or an object with a global message of type `'error' | 'success'`.
|
|
||||||
return {
|
|
||||||
type: "success",
|
|
||||||
message: "Success: Form submitted",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Form onSubmit={handleUseForm(onSubmit)}>
|
|
||||||
<input type="text" name="inputName" />
|
|
||||||
{errors.inputName != null && <p>{errors.inputName[0].message}</p>}
|
|
||||||
|
|
||||||
<button type="submit">Submit</button>
|
|
||||||
|
|
||||||
{message != null && <p>{message}</p>}
|
|
||||||
</Form>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### `useForm(schema)`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
- `schema`: The JSON schema to validate the data (recommended to use [@sinclair/typebox](https://www.npmjs.com/package/@sinclair/typebox)).
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
- `handleUseForm(onSubmit)`: Function to be used with the `onSubmit` or `onChange` prop of the `<Form />` component.
|
|
||||||
- `fetchState = 'idle'`: The current state of the form (`'error' | 'success' | 'idle' | 'loading'`).
|
|
||||||
- `setFetchState`: Function to update the `fetchState`.
|
|
||||||
- `message`: Global message of the form (not specific to a property).
|
|
||||||
- `setMessage`: Function to update the `message`.
|
|
||||||
- `errors`: Object of errors:
|
|
||||||
- Key: correspond to a property in the JSON Schema.
|
|
||||||
- Value: array of [ajv `ErrorObject`](https://ajv.js.org/api.html#error-objects).
|
|
||||||
The array will always have at least one element (never empty) in case of errors.
|
|
||||||
If the value is `undefined`, it means there are no errors for this property.
|
|
||||||
|
|
||||||
## 💡 Contributing
|
|
||||||
|
|
||||||
Anyone can help to improve the project, submit a Feature Request, a bug report or
|
|
||||||
even correct a simple spelling mistake.
|
|
||||||
|
|
||||||
The steps to contribute can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
||||||
|
|
||||||
## 📄 License
|
## 📄 License
|
||||||
|
|
||||||
|
|||||||
@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "next/core-web-vitals"
|
|
||||||
}
|
|
||||||
39
example/.gitignore
vendored
39
example/.gitignore
vendored
@ -1,39 +0,0 @@
|
|||||||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
|
|
||||||
|
|
||||||
# dependencies
|
|
||||||
/node_modules
|
|
||||||
/.pnp
|
|
||||||
.pnp.js
|
|
||||||
|
|
||||||
# testing
|
|
||||||
/coverage
|
|
||||||
cypress/screenshots
|
|
||||||
cypress/videos
|
|
||||||
cypress/downloads
|
|
||||||
|
|
||||||
# next.js
|
|
||||||
/.next/
|
|
||||||
/out/
|
|
||||||
|
|
||||||
# production
|
|
||||||
/build
|
|
||||||
|
|
||||||
# misc
|
|
||||||
.DS_Store
|
|
||||||
*.pem
|
|
||||||
|
|
||||||
# debug
|
|
||||||
npm-debug.log*
|
|
||||||
yarn-debug.log*
|
|
||||||
yarn-error.log*
|
|
||||||
.pnpm-debug.log*
|
|
||||||
|
|
||||||
# local env files
|
|
||||||
.env*.local
|
|
||||||
|
|
||||||
# vercel
|
|
||||||
.vercel
|
|
||||||
|
|
||||||
# typescript
|
|
||||||
*.tsbuildinfo
|
|
||||||
next-env.d.ts
|
|
||||||
@ -1 +0,0 @@
|
|||||||
save-exact=true
|
|
||||||
@ -1,7 +1,5 @@
|
|||||||
# example
|
This example was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||||||
|
|
||||||
This is an example for using `react-component-form` inside a Next.js application with translations thanks to [next-translate](https://www.npmjs.com/package/next-translate).
|
It is linked to the react-component-form package in the parent directory for development purposes.
|
||||||
|
|
||||||
The application shows how to use the `<Form />` component with the `useForm` hook to validate and submit a form with a `name` input and an `email` input.
|
You can run `npm install` and then `npm start` to test your package.
|
||||||
|
|
||||||
The interesting code is in [./components/FormExample.tsx](./components/FormExample.tsx).
|
|
||||||
|
|||||||
@ -1,29 +0,0 @@
|
|||||||
import Translation from "next-translate/Trans"
|
|
||||||
|
|
||||||
import { Link } from "./design/Link"
|
|
||||||
import { TextSpecial } from "./design/TextSpecial"
|
|
||||||
|
|
||||||
export const About: React.FC = () => {
|
|
||||||
return (
|
|
||||||
<section className="text-center mt-6">
|
|
||||||
<h1 className="text-4xl">{"<Form />"}</h1>
|
|
||||||
<h2 className="text-xl dark:text-gray-300 text-gray-600 mt-4">
|
|
||||||
npm install --save{" "}
|
|
||||||
<Link
|
|
||||||
href="https://www.npmjs.com/package/react-component-form"
|
|
||||||
target="_blank"
|
|
||||||
rel="noopener noreferrer"
|
|
||||||
>
|
|
||||||
react-component-form
|
|
||||||
</Link>
|
|
||||||
</h2>
|
|
||||||
|
|
||||||
<p className="max-w-lg mt-6 text-base" data-cy="main-description">
|
|
||||||
<Translation
|
|
||||||
i18nKey="common:about"
|
|
||||||
components={[<TextSpecial key="special" />]}
|
|
||||||
/>
|
|
||||||
</p>
|
|
||||||
</section>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,72 +0,0 @@
|
|||||||
"use client"
|
|
||||||
|
|
||||||
import { Form, useForm } from "react-component-form"
|
|
||||||
import type { HandleUseFormCallback } from "react-component-form"
|
|
||||||
import useTranslation from "next-translate/useTranslation"
|
|
||||||
|
|
||||||
import { Input } from "./design/Input"
|
|
||||||
import { Button } from "./design/Button"
|
|
||||||
import { useFormTranslation } from "../hooks/useFormTranslation"
|
|
||||||
import { userSchema } from "../models/User"
|
|
||||||
import { FormState } from "./design/FormState"
|
|
||||||
|
|
||||||
const fakeServerRequest = async (ms: number): Promise<void> => {
|
|
||||||
return await new Promise((resolve) => {
|
|
||||||
setTimeout(resolve, ms)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
export const FormExample: React.FC = () => {
|
|
||||||
const { handleUseForm, errors, fetchState, message } = useForm(userSchema)
|
|
||||||
const { getFirstErrorTranslation } = useFormTranslation()
|
|
||||||
const { t } = useTranslation()
|
|
||||||
|
|
||||||
const onSubmit: HandleUseFormCallback<typeof userSchema> = async (
|
|
||||||
formData,
|
|
||||||
formElement,
|
|
||||||
) => {
|
|
||||||
await fakeServerRequest(2_000)
|
|
||||||
console.log("onSubmit:", formData)
|
|
||||||
formElement.reset()
|
|
||||||
return {
|
|
||||||
type: "success",
|
|
||||||
message: "common:success-message",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<section>
|
|
||||||
<Form
|
|
||||||
className="mt-6 w-[90%] max-w-xs"
|
|
||||||
noValidate
|
|
||||||
onSubmit={handleUseForm(onSubmit)}
|
|
||||||
>
|
|
||||||
<Input
|
|
||||||
type="text"
|
|
||||||
placeholder={t("common:name")}
|
|
||||||
name="name"
|
|
||||||
label={t("common:name")}
|
|
||||||
error={getFirstErrorTranslation(errors.name)}
|
|
||||||
/>
|
|
||||||
|
|
||||||
<Input
|
|
||||||
type="text"
|
|
||||||
placeholder="Email"
|
|
||||||
name="email"
|
|
||||||
label="Email"
|
|
||||||
error={getFirstErrorTranslation(errors.email)}
|
|
||||||
/>
|
|
||||||
|
|
||||||
<Button className="mt-6 w-full" type="submit" data-cy="submit">
|
|
||||||
Submit
|
|
||||||
</Button>
|
|
||||||
</Form>
|
|
||||||
|
|
||||||
<FormState
|
|
||||||
id="message"
|
|
||||||
state={fetchState}
|
|
||||||
message={message != null ? t(message) : undefined}
|
|
||||||
/>
|
|
||||||
</section>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
import { Language } from "./Language"
|
|
||||||
import { SwitchTheme } from "./SwitchTheme"
|
|
||||||
|
|
||||||
export const Header: React.FC = () => {
|
|
||||||
return (
|
|
||||||
<header className="flex justify-center mt-6">
|
|
||||||
<Language />
|
|
||||||
<SwitchTheme />
|
|
||||||
</header>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
export const Arrow: React.FC = () => {
|
|
||||||
return (
|
|
||||||
<svg
|
|
||||||
width="12"
|
|
||||||
height="8"
|
|
||||||
viewBox="0 0 12 8"
|
|
||||||
fill="none"
|
|
||||||
xmlns="http://www.w3.org/2000/svg"
|
|
||||||
>
|
|
||||||
<path
|
|
||||||
className="fill-current text-black dark:text-white"
|
|
||||||
d="M9.8024 0.292969L5.61855 4.58597L1.43469 0.292969L0.0566406 1.70697L5.61855 7.41397L11.1805 1.70697L9.8024 0.292969Z"
|
|
||||||
/>
|
|
||||||
</svg>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
import Image from "next/image"
|
|
||||||
|
|
||||||
export interface LanguageFlagProps {
|
|
||||||
language: string
|
|
||||||
}
|
|
||||||
|
|
||||||
export const LanguageFlag: React.FC<LanguageFlagProps> = (props) => {
|
|
||||||
const { language } = props
|
|
||||||
|
|
||||||
return (
|
|
||||||
<>
|
|
||||||
<Image
|
|
||||||
quality={100}
|
|
||||||
width={35}
|
|
||||||
height={35}
|
|
||||||
src={`/images/languages/${language}.svg`}
|
|
||||||
alt={language}
|
|
||||||
/>
|
|
||||||
<p data-cy="language-flag-text" className="mx-2 text-base">
|
|
||||||
{language.toUpperCase()}
|
|
||||||
</p>
|
|
||||||
</>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,80 +0,0 @@
|
|||||||
import { useCallback, useEffect, useState, useRef } from "react"
|
|
||||||
import useTranslation from "next-translate/useTranslation"
|
|
||||||
import setLanguage from "next-translate/setLanguage"
|
|
||||||
import classNames from "clsx"
|
|
||||||
|
|
||||||
import i18n from "../../../i18n.json"
|
|
||||||
import { Arrow } from "./Arrow"
|
|
||||||
import { LanguageFlag } from "./LanguageFlag"
|
|
||||||
|
|
||||||
export const Language: React.FC = () => {
|
|
||||||
const { lang: currentLanguage } = useTranslation()
|
|
||||||
const [hiddenMenu, setHiddenMenu] = useState(true)
|
|
||||||
const languageClickRef = useRef<HTMLDivElement | null>(null)
|
|
||||||
|
|
||||||
const handleHiddenMenu = useCallback(() => {
|
|
||||||
setHiddenMenu((oldHiddenMenu) => {
|
|
||||||
return !oldHiddenMenu
|
|
||||||
})
|
|
||||||
}, [])
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
const handleClickEvent = (event: MouseEvent): void => {
|
|
||||||
if (languageClickRef.current == null || event.target == null) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if (!languageClickRef.current.contains(event.target as Node)) {
|
|
||||||
setHiddenMenu(true)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
window.document.addEventListener("click", handleClickEvent)
|
|
||||||
|
|
||||||
return () => {
|
|
||||||
return window.removeEventListener("click", handleClickEvent)
|
|
||||||
}
|
|
||||||
}, [])
|
|
||||||
|
|
||||||
const handleLanguage = async (language: string): Promise<void> => {
|
|
||||||
await setLanguage(language)
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className="flex cursor-pointer flex-col items-center justify-center">
|
|
||||||
<div
|
|
||||||
ref={languageClickRef}
|
|
||||||
data-cy="language-click"
|
|
||||||
className="mr-5 flex items-center"
|
|
||||||
onClick={handleHiddenMenu}
|
|
||||||
>
|
|
||||||
<LanguageFlag language={currentLanguage} />
|
|
||||||
<Arrow />
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<ul
|
|
||||||
data-cy="languages-list"
|
|
||||||
className={classNames(
|
|
||||||
"absolute top-14 z-10 mt-3 mr-4 flex w-24 list-none flex-col items-center justify-center rounded-lg bg-white p-0 shadow-lightFlag dark:bg-black dark:shadow-darkFlag",
|
|
||||||
{ hidden: hiddenMenu },
|
|
||||||
)}
|
|
||||||
>
|
|
||||||
{i18n.locales.map((language, index) => {
|
|
||||||
if (language === currentLanguage) {
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
return (
|
|
||||||
<li
|
|
||||||
key={index}
|
|
||||||
className="flex h-12 w-full items-center justify-center pl-2 hover:bg-[#4f545c] hover:bg-opacity-20"
|
|
||||||
onClick={async () => {
|
|
||||||
await handleLanguage(language)
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<LanguageFlag language={language} />
|
|
||||||
</li>
|
|
||||||
)
|
|
||||||
})}
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,78 +0,0 @@
|
|||||||
import { useEffect, useState } from "react"
|
|
||||||
import classNames from "clsx"
|
|
||||||
import { useTheme } from "next-themes"
|
|
||||||
|
|
||||||
export const SwitchTheme: React.FC = () => {
|
|
||||||
const [mounted, setMounted] = useState(false)
|
|
||||||
const { theme, setTheme } = useTheme()
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
setMounted(true)
|
|
||||||
}, [])
|
|
||||||
|
|
||||||
if (!mounted) {
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleClick = (): void => {
|
|
||||||
setTheme(theme === "dark" ? "light" : "dark")
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div
|
|
||||||
className="flex items-center"
|
|
||||||
data-cy="switch-theme-click"
|
|
||||||
onClick={handleClick}
|
|
||||||
>
|
|
||||||
<div className="relative inline-block cursor-pointer touch-pan-x select-none border-0 bg-transparent p-0">
|
|
||||||
<div className="h-[24px] w-[50px] rounded-[30px] bg-[#4d4d4d] p-0 text-white transition-all duration-200 ease-in-out">
|
|
||||||
<div
|
|
||||||
data-cy="switch-theme-dark"
|
|
||||||
className={classNames(
|
|
||||||
"absolute top-0 bottom-0 left-[8px] mt-auto mb-auto h-[10px] w-[14px] leading-[0] transition-opacity duration-[250ms] ease-in-out",
|
|
||||||
{
|
|
||||||
"opacity-100": theme === "dark",
|
|
||||||
"opacity-0": theme === "light",
|
|
||||||
},
|
|
||||||
)}
|
|
||||||
>
|
|
||||||
<span className="relative flex h-[10px] w-[10px] items-center justify-center">
|
|
||||||
🌜
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
<div
|
|
||||||
data-cy="switch-theme-light"
|
|
||||||
className={classNames(
|
|
||||||
"absolute right-[10px] top-0 bottom-0 mt-auto mb-auto h-[10px] w-[10px] leading-[0]",
|
|
||||||
{
|
|
||||||
"opacity-100": theme === "light",
|
|
||||||
"opacity-0": theme === "dark",
|
|
||||||
},
|
|
||||||
)}
|
|
||||||
>
|
|
||||||
<span className="relative flex h-[10px] w-[10px] items-center justify-center">
|
|
||||||
🌞
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div
|
|
||||||
className={classNames(
|
|
||||||
"absolute top-[1px] box-border h-[22px] w-[22px] rounded-[50%] bg-[#fafafa] text-white transition-all duration-[250ms] ease-in-out",
|
|
||||||
{
|
|
||||||
"left-[27px]": theme === "dark",
|
|
||||||
"left-0": theme === "light",
|
|
||||||
},
|
|
||||||
)}
|
|
||||||
style={{ border: "1px solid #4d4d4d" }}
|
|
||||||
/>
|
|
||||||
<input
|
|
||||||
data-cy="switch-theme-input"
|
|
||||||
type="checkbox"
|
|
||||||
aria-label="Dark mode toggle"
|
|
||||||
className="absolute m-[-1px] h-[1px] w-[1px] overflow-hidden border-0 p-0"
|
|
||||||
defaultChecked
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1 +0,0 @@
|
|||||||
export * from "./Header"
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
import classNames from "clsx"
|
|
||||||
|
|
||||||
export interface ButtonProps extends React.ComponentPropsWithoutRef<"button"> {}
|
|
||||||
|
|
||||||
export const Button: React.FC<ButtonProps> = (props) => {
|
|
||||||
const { children, className, ...rest } = props
|
|
||||||
|
|
||||||
return (
|
|
||||||
<button
|
|
||||||
className={classNames(
|
|
||||||
"py-2 px-6 font-paragraph rounded-lg bg-transparent border hover:text-white dark:hover:text-black fill-current stroke-current transform transition-colors duration-300 ease-in-out focus:outline-none focus:text-white dark:focus:text-black border-green-800 dark:border-green-400 text-green-800 dark:text-green-400 hover:bg-green-800 focus:bg-green-800 dark:focus:bg-green-400 dark:hover:bg-green-400",
|
|
||||||
className,
|
|
||||||
)}
|
|
||||||
{...rest}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</button>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,49 +0,0 @@
|
|||||||
import classNames from "clsx"
|
|
||||||
import useTranslation from "next-translate/useTranslation"
|
|
||||||
import type { FetchState as FormStateType } from "react-component-form"
|
|
||||||
|
|
||||||
import { Loader } from "./Loader"
|
|
||||||
|
|
||||||
export interface FormStateProps extends React.ComponentPropsWithoutRef<"div"> {
|
|
||||||
state: FormStateType
|
|
||||||
message?: string
|
|
||||||
id?: string
|
|
||||||
}
|
|
||||||
|
|
||||||
export const FormState: React.FC<FormStateProps> = (props) => {
|
|
||||||
const { state, message, id, ...rest } = props
|
|
||||||
const { t } = useTranslation()
|
|
||||||
|
|
||||||
if (state === "loading") {
|
|
||||||
return (
|
|
||||||
<div data-cy="loader" className="mt-8 flex justify-center">
|
|
||||||
<Loader />
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (state === "idle" || message == null) {
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<>
|
|
||||||
<div
|
|
||||||
{...rest}
|
|
||||||
className={classNames(
|
|
||||||
props.className,
|
|
||||||
"mt-6 flex max-w-xl items-center text-center font-medium",
|
|
||||||
{
|
|
||||||
"text-red-800 dark:text-red-400": state === "error",
|
|
||||||
"text-green-800 dark:text-green-400": state === "success",
|
|
||||||
},
|
|
||||||
)}
|
|
||||||
>
|
|
||||||
<div className="inline bg-cover font-headline" />
|
|
||||||
<span id={id} className="pl-2">
|
|
||||||
<b>{t(`common:${state}`)}:</b> {message}
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
</>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,37 +0,0 @@
|
|||||||
import classNames from "clsx"
|
|
||||||
|
|
||||||
import { FormState } from "./FormState"
|
|
||||||
|
|
||||||
export interface InputProps extends React.ComponentPropsWithRef<"input"> {
|
|
||||||
label: string
|
|
||||||
error?: string
|
|
||||||
className?: string
|
|
||||||
}
|
|
||||||
|
|
||||||
export const Input: React.FC<InputProps> = (props) => {
|
|
||||||
const { label, name, className, error, ...rest } = props
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className="flex flex-col">
|
|
||||||
<div className={classNames("mt-6 mb-2 flex justify-between", className)}>
|
|
||||||
<label className="pl-1" htmlFor={name}>
|
|
||||||
{label}
|
|
||||||
</label>
|
|
||||||
</div>
|
|
||||||
<div className="relative mt-0">
|
|
||||||
<input
|
|
||||||
className="h-11 w-full rounded-lg border border-transparent bg-[#f1f1f1] px-3 font-paragraph leading-10 text-[#2a2a2a] caret-green-600 focus:border focus:shadow-green focus:outline-none"
|
|
||||||
{...rest}
|
|
||||||
id={name}
|
|
||||||
name={name}
|
|
||||||
data-cy={`input-${name ?? "name"}`}
|
|
||||||
/>
|
|
||||||
<FormState
|
|
||||||
id={`error-${name ?? "input"}`}
|
|
||||||
state={error == null ? "idle" : "error"}
|
|
||||||
message={error}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
import classNames from "clsx"
|
|
||||||
|
|
||||||
export interface LinkProps extends React.ComponentPropsWithoutRef<"a"> {}
|
|
||||||
|
|
||||||
export const Link: React.FC<LinkProps> = (props) => {
|
|
||||||
const { children, className, ...rest } = props
|
|
||||||
|
|
||||||
return (
|
|
||||||
<a
|
|
||||||
className={classNames(
|
|
||||||
"text-green-800 hover:underline dark:text-green-400",
|
|
||||||
className,
|
|
||||||
)}
|
|
||||||
{...rest}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</a>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,39 +0,0 @@
|
|||||||
@keyframes progressSpinnerRotate {
|
|
||||||
100% {
|
|
||||||
transform: rotate(360deg);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@keyframes progressSpinnerDash {
|
|
||||||
0% {
|
|
||||||
stroke-dasharray: 1, 200;
|
|
||||||
stroke-dashoffset: 0;
|
|
||||||
}
|
|
||||||
50% {
|
|
||||||
stroke-dasharray: 89, 200;
|
|
||||||
stroke-dashoffset: -35px;
|
|
||||||
}
|
|
||||||
100% {
|
|
||||||
stroke-dasharray: 89, 200;
|
|
||||||
stroke-dashoffset: -124px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.progressSpinnerSvg {
|
|
||||||
animation: progressSpinnerRotate 2s linear infinite;
|
|
||||||
height: 100%;
|
|
||||||
transform-origin: center center;
|
|
||||||
width: 100%;
|
|
||||||
position: absolute;
|
|
||||||
top: 0;
|
|
||||||
bottom: 0;
|
|
||||||
left: 0;
|
|
||||||
right: 0;
|
|
||||||
margin: auto;
|
|
||||||
}
|
|
||||||
.progressSpinnerCircle {
|
|
||||||
stroke-dasharray: 89, 200;
|
|
||||||
stroke-dashoffset: 0;
|
|
||||||
stroke: #27b05e;
|
|
||||||
animation: progressSpinnerDash 1.5s ease-in-out infinite;
|
|
||||||
stroke-linecap: round;
|
|
||||||
}
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
import styles from "./Loader.module.css"
|
|
||||||
|
|
||||||
export interface LoaderProps {
|
|
||||||
width?: number
|
|
||||||
height?: number
|
|
||||||
className?: string
|
|
||||||
}
|
|
||||||
|
|
||||||
export const Loader: React.FC<LoaderProps> = (props) => {
|
|
||||||
const { width = 50, height = 50, className } = props
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className={className}>
|
|
||||||
<div
|
|
||||||
data-cy="progress-spinner"
|
|
||||||
className="relative my-0 mx-auto before:content-none before:block before:pt-[100%]"
|
|
||||||
style={{ width: `${width}px`, height: `${height}px` }}
|
|
||||||
>
|
|
||||||
<svg className={styles["progressSpinnerSvg"]} viewBox="25 25 50 50">
|
|
||||||
<circle
|
|
||||||
className={styles["progressSpinnerCircle"]}
|
|
||||||
cx="50"
|
|
||||||
cy="50"
|
|
||||||
r="20"
|
|
||||||
fill="none"
|
|
||||||
strokeWidth="2"
|
|
||||||
strokeMiterlimit="10"
|
|
||||||
/>
|
|
||||||
</svg>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1 +0,0 @@
|
|||||||
export * from "./Loader"
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
import classNames from "clsx"
|
|
||||||
|
|
||||||
export interface TextSpecialProps
|
|
||||||
extends React.ComponentPropsWithoutRef<"span"> {}
|
|
||||||
|
|
||||||
export const TextSpecial: React.FC<TextSpecialProps> = (props) => {
|
|
||||||
const { children, className, ...rest } = props
|
|
||||||
|
|
||||||
return (
|
|
||||||
<span
|
|
||||||
className={classNames("text-green-800 dark:text-green-400", className)}
|
|
||||||
{...rest}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</span>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
import { defineConfig } from "cypress"
|
|
||||||
|
|
||||||
export default defineConfig({
|
|
||||||
fixturesFolder: false,
|
|
||||||
video: false,
|
|
||||||
downloadsFolder: undefined,
|
|
||||||
screenshotOnRunFailure: false,
|
|
||||||
e2e: {
|
|
||||||
baseUrl: "http://127.0.0.1:3000",
|
|
||||||
supportFile: false,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@ -1,65 +0,0 @@
|
|||||||
describe("Form", () => {
|
|
||||||
beforeEach(() => {
|
|
||||||
cy.visit("/")
|
|
||||||
})
|
|
||||||
|
|
||||||
it("succeeds, reset input values and display the global success message", () => {
|
|
||||||
cy.get("[data-cy=input-name]").type("John")
|
|
||||||
cy.get("[data-cy=input-email]").type("john@john.com")
|
|
||||||
cy.get("#error-name").should("not.exist")
|
|
||||||
cy.get("#error-email").should("not.exist")
|
|
||||||
cy.get("[data-cy=submit]").click()
|
|
||||||
cy.get("[data-cy=input-name]").should("have.value", "")
|
|
||||||
cy.get("[data-cy=input-email]").should("have.value", "")
|
|
||||||
cy.get("#message").should(
|
|
||||||
"have.text",
|
|
||||||
"Success: The form has been submitted.",
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it("fails with all inputs as required with error messages and update error messages when updating language (translation)", () => {
|
|
||||||
const requiredErrorMessage = {
|
|
||||||
en: "Error: Oops, this field is required 🙈.",
|
|
||||||
fr: "Erreur: Oups, ce champ est obligatoire 🙈.",
|
|
||||||
}
|
|
||||||
cy.get("#error-name").should("not.exist")
|
|
||||||
cy.get("#error-email").should("not.exist")
|
|
||||||
cy.get("[data-cy=submit]").click()
|
|
||||||
cy.get("#error-name").should("have.text", requiredErrorMessage.en)
|
|
||||||
cy.get("#error-email").should("have.text", requiredErrorMessage.en)
|
|
||||||
cy.get("[data-cy=language-click]").click()
|
|
||||||
cy.get("[data-cy=languages-list] > li:first-child").contains("FR").click()
|
|
||||||
cy.get("#error-name").should("have.text", requiredErrorMessage.fr)
|
|
||||||
cy.get("#error-email").should("have.text", requiredErrorMessage.fr)
|
|
||||||
})
|
|
||||||
|
|
||||||
it("fails with invalid name (less than 3 characters)", () => {
|
|
||||||
cy.get("[data-cy=input-name]").type("a")
|
|
||||||
cy.get("[data-cy=submit]").click()
|
|
||||||
cy.get("#error-name").should(
|
|
||||||
"have.text",
|
|
||||||
"Error: The field must contain at least 3 characters.",
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it("fails with invalid name (more than 10 characters)", () => {
|
|
||||||
cy.get("[data-cy=input-name]").type("12345678910aaaa")
|
|
||||||
cy.get("[data-cy=submit]").click()
|
|
||||||
cy.get("#error-name").should(
|
|
||||||
"have.text",
|
|
||||||
"Error: The field must contain at most 10 characters.",
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it("fails with wrong email format", () => {
|
|
||||||
cy.get("#error-email").should("not.exist")
|
|
||||||
cy.get("[data-cy=input-email]").type("test")
|
|
||||||
cy.get("[data-cy=submit]").click()
|
|
||||||
cy.get("#error-email").should(
|
|
||||||
"have.text",
|
|
||||||
"Error: Mmm… It seems that this email is not valid 🤔.",
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
export {}
|
|
||||||
@ -1,49 +0,0 @@
|
|||||||
describe("Header", () => {
|
|
||||||
beforeEach(() => cy.visit("/"))
|
|
||||||
|
|
||||||
describe("Switch theme color (dark/light)", () => {
|
|
||||||
it("should switch theme from `dark` (default) to `light`", () => {
|
|
||||||
cy.get("[data-cy=switch-theme-dark]").should("be.visible")
|
|
||||||
cy.get("[data-cy=switch-theme-light]").should("not.be.visible")
|
|
||||||
cy.get("body").should(
|
|
||||||
"not.have.css",
|
|
||||||
"background-color",
|
|
||||||
"rgb(255, 255, 255)",
|
|
||||||
)
|
|
||||||
|
|
||||||
cy.get("[data-cy=switch-theme-click]").click()
|
|
||||||
|
|
||||||
cy.get("[data-cy=switch-theme-dark]").should("not.be.visible")
|
|
||||||
cy.get("[data-cy=switch-theme-light]").should("be.visible")
|
|
||||||
cy.get("body").should(
|
|
||||||
"have.css",
|
|
||||||
"background-color",
|
|
||||||
"rgb(255, 255, 255)",
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe("Switch Language", () => {
|
|
||||||
it("should switch language from EN (default) to FR", () => {
|
|
||||||
cy.get("[data-cy=main-description]").contains("This is an example")
|
|
||||||
cy.get("[data-cy=language-flag-text]").contains("EN")
|
|
||||||
cy.get("[data-cy=languages-list]").should("not.be.visible")
|
|
||||||
cy.get("[data-cy=language-click]").click()
|
|
||||||
cy.get("[data-cy=languages-list]").should("be.visible")
|
|
||||||
cy.get("[data-cy=languages-list] > li:first-child").contains("FR").click()
|
|
||||||
cy.get("[data-cy=languages-list]").should("not.be.visible")
|
|
||||||
cy.get("[data-cy=language-flag-text]").contains("FR")
|
|
||||||
cy.get("[data-cy=main-description]").contains("Ceci est un exemple")
|
|
||||||
})
|
|
||||||
|
|
||||||
it("should close the language list menu when clicking outside", () => {
|
|
||||||
cy.get("[data-cy=languages-list]").should("not.be.visible")
|
|
||||||
cy.get("[data-cy=language-click]").click()
|
|
||||||
cy.get("[data-cy=languages-list]").should("be.visible")
|
|
||||||
cy.get("[data-cy=main-description]").click()
|
|
||||||
cy.get("[data-cy=languages-list]").should("not.be.visible")
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
export {}
|
|
||||||
@ -1,51 +0,0 @@
|
|||||||
import useTranslation from "next-translate/useTranslation"
|
|
||||||
import type { Error } from "react-component-form"
|
|
||||||
|
|
||||||
const knownErrorKeywords = ["minLength", "maxLength", "format"]
|
|
||||||
|
|
||||||
const getErrorTranslationKey = (error: Error): string => {
|
|
||||||
if (knownErrorKeywords.includes(error?.keyword)) {
|
|
||||||
if (
|
|
||||||
error.keyword === "minLength" &&
|
|
||||||
typeof error.data === "string" &&
|
|
||||||
error.data.length === 0
|
|
||||||
) {
|
|
||||||
return "common:required"
|
|
||||||
}
|
|
||||||
if (error.keyword === "format") {
|
|
||||||
if (error.params["format"] === "email") {
|
|
||||||
return "common:invalid-email"
|
|
||||||
}
|
|
||||||
return "common:invalid"
|
|
||||||
}
|
|
||||||
return `common:${error.keyword}`
|
|
||||||
}
|
|
||||||
return "common:invalid"
|
|
||||||
}
|
|
||||||
|
|
||||||
export const useFormTranslation = () => {
|
|
||||||
const { t } = useTranslation()
|
|
||||||
|
|
||||||
const getErrorTranslation = (
|
|
||||||
error: Error | undefined,
|
|
||||||
): string | undefined => {
|
|
||||||
if (error != null) {
|
|
||||||
return t(getErrorTranslationKey(error)).replace(
|
|
||||||
"{expected}",
|
|
||||||
error?.params?.["limit"],
|
|
||||||
)
|
|
||||||
}
|
|
||||||
return undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
const getFirstErrorTranslation = (
|
|
||||||
errors: Error[] | undefined,
|
|
||||||
): string | undefined => {
|
|
||||||
if (errors != null) {
|
|
||||||
return getErrorTranslation(errors[0])
|
|
||||||
}
|
|
||||||
return undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
return { getFirstErrorTranslation, getErrorTranslation }
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"locales": ["en", "fr"],
|
|
||||||
"defaultLocale": "en",
|
|
||||||
"pages": {
|
|
||||||
"*": ["common"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
{
|
|
||||||
"about": "This is an example of using <0>`react-component-form`</0> inside a Next.js application. The application shows how to use the <0>`<Form />`</0> component with the <0>`useForm`</0> hook to validate and submit a form with a <0>`name`</0> and an <0>`email`</0> input.",
|
|
||||||
"name": "Name",
|
|
||||||
"error": "Error",
|
|
||||||
"success": "Success",
|
|
||||||
"success-message": "The form has been submitted.",
|
|
||||||
"page-not-found": "This page could not be found.",
|
|
||||||
"server-error": "Internal Server Error.",
|
|
||||||
"return-to-home-page": "Return to the home page?",
|
|
||||||
"required": "Oops, this field is required 🙈.",
|
|
||||||
"minLength": "The field must contain at least {expected} characters.",
|
|
||||||
"maxLength": "The field must contain at most {expected} characters.",
|
|
||||||
"invalid-email": "Mmm… It seems that this email is not valid 🤔.",
|
|
||||||
"invalid": "Invalid value."
|
|
||||||
}
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
{
|
|
||||||
"about": "Ceci est un exemple d'utilisation de <0>`react-component-form`</0> dans une application Next.js. L'application montre comment utiliser le composant <0>`<Form />`</0> avec le hook <0>`useForm`</0> hook pour valider et soumettre un formulaire avec un input `name` et `email`.",
|
|
||||||
"name": "Nom",
|
|
||||||
"error": "Erreur",
|
|
||||||
"success": "Succès",
|
|
||||||
"success-message": "Le formulaire a été envoyé.",
|
|
||||||
"page-not-found": "Cette page est introuvable.",
|
|
||||||
"server-error": "Erreur interne du serveur.",
|
|
||||||
"return-to-home-page": "Revenir à la page d'accueil ?",
|
|
||||||
"required": "Oups, ce champ est obligatoire 🙈.",
|
|
||||||
"minLength": "Le champ doit contenir au moins {expected} caractères.",
|
|
||||||
"maxLength": "Le champ doit contenir au plus {expected} caractères.",
|
|
||||||
"invalid-email": "Mmm… Il semblerait que cet email ne soit pas valide 🤔.",
|
|
||||||
"invalid": "Valeur invalide."
|
|
||||||
}
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
import type { Static } from "@sinclair/typebox"
|
|
||||||
import { Type } from "@sinclair/typebox"
|
|
||||||
|
|
||||||
export const userSchema = {
|
|
||||||
name: Type.String({ minLength: 3, maxLength: 10 }),
|
|
||||||
email: Type.String({ minLength: 1, maxLength: 254, format: "email" }),
|
|
||||||
}
|
|
||||||
|
|
||||||
export const userObjectSchema = Type.Object(userSchema)
|
|
||||||
|
|
||||||
export type User = Static<typeof userObjectSchema>
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
const nextTranslate = require("next-translate-plugin")
|
|
||||||
|
|
||||||
/** @type {import('next').NextConfig} */
|
|
||||||
const nextConfig = {
|
|
||||||
reactStrictMode: true,
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = nextTranslate(nextConfig)
|
|
||||||
36412
example/package-lock.json
generated
36412
example/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -1,38 +1,44 @@
|
|||||||
{
|
{
|
||||||
"name": "example",
|
"name": "react-component-form-example",
|
||||||
"version": "1.0.0",
|
"homepage": ".",
|
||||||
|
"version": "0.0.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "next dev",
|
"start": "node ../node_modules/react-scripts/bin/react-scripts.js start",
|
||||||
"build": "next build",
|
"build": "node ../node_modules/react-scripts/bin/react-scripts.js build",
|
||||||
"start": "next start",
|
"test": "node ../node_modules/react-scripts/bin/react-scripts.js test",
|
||||||
"lint": "next lint",
|
"eject": "node ../node_modules/react-scripts/bin/react-scripts.js eject"
|
||||||
"test:e2e": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"cypress run\"",
|
|
||||||
"test:dev": "start-server-and-test \"dev\" \"http://127.0.0.1:3000\" \"cypress open\""
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@sinclair/typebox": "0.32.13",
|
"@testing-library/jest-dom": "file:../node_modules/@testing-library/jest-dom",
|
||||||
"clsx": "2.1.0",
|
"@testing-library/react": "file:../node_modules/@testing-library/react",
|
||||||
"next": "13.2.4",
|
"@testing-library/user-event": "file:../node_modules/@testing-library/user-event",
|
||||||
"next-themes": "0.2.1",
|
"@types/jest": "file:../node_modules/@types/jest",
|
||||||
"next-translate": "2.0.5",
|
"@types/node": "file:../node_modules/@types/node",
|
||||||
"react": "18.2.0",
|
"@types/react": "file:../node_modules/@types/react",
|
||||||
|
"@types/react-dom": "file:../node_modules/@types/react-dom",
|
||||||
|
"react": "file:../node_modules/react",
|
||||||
"react-component-form": "file:..",
|
"react-component-form": "file:..",
|
||||||
"react-dom": "18.2.0"
|
"react-dom": "file:../node_modules/react-dom",
|
||||||
|
"react-scripts": "file:../node_modules/react-scripts",
|
||||||
|
"typescript": "file:../node_modules/typescript"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@tsconfig/strictest": "2.0.2",
|
"@babel/plugin-syntax-object-rest-spread": "^7.8.3"
|
||||||
"@types/node": "20.11.10",
|
},
|
||||||
"@types/react": "18.2.48",
|
"eslintConfig": {
|
||||||
"@types/react-dom": "18.2.18",
|
"extends": "react-app"
|
||||||
"autoprefixer": "10.4.17",
|
},
|
||||||
"cypress": "13.6.3",
|
"browserslist": {
|
||||||
"eslint": "8.56.0",
|
"production": [
|
||||||
"eslint-config-next": "13.2.4",
|
">0.2%",
|
||||||
"next-translate-plugin": "2.0.5",
|
"not dead",
|
||||||
"postcss": "8.4.33",
|
"not op_mini all"
|
||||||
"start-server-and-test": "2.0.3",
|
],
|
||||||
"tailwindcss": "3.4.1",
|
"development": [
|
||||||
"typescript": "5.3.3"
|
"last 1 chrome version",
|
||||||
|
"last 1 firefox version",
|
||||||
|
"last 1 safari version"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,14 +0,0 @@
|
|||||||
import type { AppType } from "next/app"
|
|
||||||
import { ThemeProvider } from "next-themes"
|
|
||||||
|
|
||||||
import "../styles/globals.css"
|
|
||||||
|
|
||||||
const MyApp: AppType = ({ Component, pageProps }) => {
|
|
||||||
return (
|
|
||||||
<ThemeProvider attribute="class" defaultTheme="dark">
|
|
||||||
<Component {...pageProps} />
|
|
||||||
</ThemeProvider>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
export default MyApp
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
import { Html, Head, Main, NextScript } from "next/document"
|
|
||||||
|
|
||||||
const Document: React.FC = () => {
|
|
||||||
return (
|
|
||||||
<Html>
|
|
||||||
<Head />
|
|
||||||
<body className="bg-white text-black dark:bg-black dark:text-white">
|
|
||||||
<Main />
|
|
||||||
<NextScript />
|
|
||||||
</body>
|
|
||||||
</Html>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
export default Document
|
|
||||||
@ -1,30 +0,0 @@
|
|||||||
import type { GetStaticProps, NextPage } from "next"
|
|
||||||
import Head from "next/head"
|
|
||||||
|
|
||||||
import { About } from "../components/About"
|
|
||||||
import { FormExample } from "../components/FormExample"
|
|
||||||
import { Header } from "../components/Header"
|
|
||||||
|
|
||||||
const Home: NextPage = () => {
|
|
||||||
return (
|
|
||||||
<>
|
|
||||||
<Head>
|
|
||||||
<title>react-component-form</title>
|
|
||||||
<meta name="description" content="Manage React Forms with ease." />
|
|
||||||
<link rel="icon" href="/favicon.ico" />
|
|
||||||
</Head>
|
|
||||||
|
|
||||||
<Header />
|
|
||||||
<main className="flex flex-col justify-center items-center mt-4">
|
|
||||||
<About />
|
|
||||||
<FormExample />
|
|
||||||
</main>
|
|
||||||
</>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
export const getStaticProps: GetStaticProps = async () => {
|
|
||||||
return { props: {} }
|
|
||||||
}
|
|
||||||
|
|
||||||
export default Home
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
plugins: {
|
|
||||||
tailwindcss: {},
|
|
||||||
autoprefixer: {},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 3.8 KiB |
@ -1,30 +0,0 @@
|
|||||||
<svg width="60" height="60" viewBox="0 0 60 60" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
||||||
<path d="M46 4.6C41.3 1.7 35.9 0 30 0V4.6H46Z" fill="#ED4C5C"/>
|
|
||||||
<path d="M30 9.2H51.6C49.9 7.5 48 5.9 46 4.6H30V9.2Z" fill="white"/>
|
|
||||||
<path d="M30 13.8H55.3C54.2 12.1 53 10.6 51.7 9.2H30V13.8Z" fill="#ED4C5C"/>
|
|
||||||
<path d="M30 18.4H57.7C57 16.8 56.2 15.2 55.3 13.8H30V18.4Z" fill="white"/>
|
|
||||||
<path d="M30 23H59.2C58.8 21.4 58.3 19.9 57.7 18.4H30V23Z" fill="#ED4C5C"/>
|
|
||||||
<path d="M30 27.7H59.9C59.8 26.1 59.5 24.6 59.2 23.1H30V27.7Z" fill="white"/>
|
|
||||||
<path d="M59.9 27.7H30V30H0C0 30.8 -9.68575e-08 31.5 0.0999999 32.3H59.9C60 31.5 60 30.8 60 30C60 29.2 60 28.4 59.9 27.7Z" fill="#ED4C5C"/>
|
|
||||||
<path d="M0.800006 36.9H59.2C59.6 35.4 59.8 33.9 59.9 32.3H0.100006C0.200006 33.8 0.400006 35.4 0.800006 36.9Z" fill="white"/>
|
|
||||||
<path d="M2.3 41.5H57.7C58.3 40 58.8 38.5 59.2 36.9H0.800003C1.2 38.5 1.7 40 2.3 41.5Z" fill="#ED4C5C"/>
|
|
||||||
<path d="M4.7 46.1H55.3C56.2 44.6 57 43.1 57.7 41.5H2.3C3 43.1 3.8 44.6 4.7 46.1Z" fill="white"/>
|
|
||||||
<path d="M8.3 50.7H51.7C53 49.3 54.3 47.7 55.3 46.1H4.7C5.7 47.8 7 49.3 8.3 50.7Z" fill="#ED4C5C"/>
|
|
||||||
<path d="M13.9 55.3H46.1C48.2 54 50 52.4 51.7 50.7H8.3C10 52.5 11.9 54 13.9 55.3Z" fill="white"/>
|
|
||||||
<path d="M30 60C35.9 60 41.4 58.3 46.1 55.3H13.9C18.6 58.3 24.1 60 30 60Z" fill="#ED4C5C"/>
|
|
||||||
<path d="M14 4.6C11.9 5.9 10 7.5 8.3 9.2C6.9 10.6 5.7 12.2 4.7 13.8C3.8 15.3 2.9 16.8 2.3 18.4C1.7 19.9 1.2 21.4 0.8 23C0.4 24.5 0.2 26 0.0999999 27.6C-9.68575e-08 28.4 0 29.2 0 30H30V0C24.1 0 18.7 1.7 14 4.6Z" fill="#428BC1"/>
|
|
||||||
<path d="M23 1L23.5 2.5H25L23.8 3.5L24.2 5L23 4.1L21.8 5L22.2 3.5L21 2.5H22.5L23 1Z" fill="white"/>
|
|
||||||
<path d="M27 7L27.5 8.5H29L27.8 9.5L28.2 11L27 10.1L25.8 11L26.2 9.5L25 8.5H26.5L27 7Z" fill="white"/>
|
|
||||||
<path d="M19 7L19.5 8.5H21L19.8 9.5L20.2 11L19 10.1L17.8 11L18.2 9.5L17 8.5H18.5L19 7Z" fill="white"/>
|
|
||||||
<path d="M23 13L23.5 14.5H25L23.8 15.5L24.2 17L23 16.1L21.8 17L22.2 15.5L21 14.5H22.5L23 13Z" fill="white"/>
|
|
||||||
<path d="M15 13L15.5 14.5H17L15.8 15.5L16.2 17L15 16.1L13.8 17L14.2 15.5L13 14.5H14.5L15 13Z" fill="white"/>
|
|
||||||
<path d="M7 13L7.5 14.5H9L7.8 15.5L8.2 17L7 16.1L5.8 17L6.2 15.5L5 14.5H6.5L7 13Z" fill="white"/>
|
|
||||||
<path d="M27 19L27.5 20.5H29L27.8 21.5L28.2 23L27 22.1L25.8 23L26.2 21.5L25 20.5H26.5L27 19Z" fill="white"/>
|
|
||||||
<path d="M19 19L19.5 20.5H21L19.8 21.5L20.2 23L19 22.1L17.8 23L18.2 21.5L17 20.5H18.5L19 19Z" fill="white"/>
|
|
||||||
<path d="M11 19L11.5 20.5H13L11.8 21.5L12.2 23L11 22.1L9.8 23L10.2 21.5L9 20.5H10.5L11 19Z" fill="white"/>
|
|
||||||
<path d="M23 25L23.5 26.5H25L23.8 27.5L24.2 29L23 28.1L21.8 29L22.2 27.5L21 26.5H22.5L23 25Z" fill="white"/>
|
|
||||||
<path d="M15 25L15.5 26.5H17L15.8 27.5L16.2 29L15 28.1L13.8 29L14.2 27.5L13 26.5H14.5L15 25Z" fill="white"/>
|
|
||||||
<path d="M7 25L7.5 26.5H9L7.8 27.5L8.2 29L7 28.1L5.8 29L6.2 27.5L5 26.5H6.5L7 25Z" fill="white"/>
|
|
||||||
<path d="M9.79999 11L11 10.1L12.2 11L11.7 9.5L12.9 8.5H11.4L11 7L10.5 8.5H9.09999L10.3 9.4L9.79999 11Z" fill="white"/>
|
|
||||||
<path d="M1.79999 23L2.99999 22.1L4.19999 23L3.69999 21.5L4.89999 20.5H3.49999L2.99999 19L2.49999 20.5H1.49999C1.49999 20.6 1.39999 20.7 1.39999 20.8L2.19999 21.4L1.79999 23Z" fill="white"/>
|
|
||||||
</svg>
|
|
||||||
|
Before Width: | Height: | Size: 3.0 KiB |
@ -1,12 +0,0 @@
|
|||||||
<svg width="35" height="35" viewBox="0 0 35 35" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
||||||
<g clip-path="url(#clip0)">
|
|
||||||
<path d="M0 17.5C0 25.1417 4.9 31.6167 11.6667 34.0084V0.991699C4.9 3.38337 0 9.85837 0 17.5Z" fill="#428BC1"/>
|
|
||||||
<path d="M35 17.5C35 9.85837 30.1584 3.38337 23.3334 0.991699V34.0084C30.1584 31.6167 35 25.1417 35 17.5Z" fill="#ED4C5C"/>
|
|
||||||
<path d="M11.6666 34.0083C13.475 34.65 15.4583 35 17.5 35C19.5416 35 21.525 34.65 23.3333 34.0083V0.991667C21.525 0.35 19.6 0 17.5 0C15.4 0 13.475 0.35 11.6666 0.991667V34.0083Z" fill="white"/>
|
|
||||||
</g>
|
|
||||||
<defs>
|
|
||||||
<clipPath id="clip0">
|
|
||||||
<rect width="35" height="35" fill="white"/>
|
|
||||||
</clipPath>
|
|
||||||
</defs>
|
|
||||||
</svg>
|
|
||||||
|
Before Width: | Height: | Size: 659 B |
48
example/public/index.html
Normal file
48
example/public/index.html
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico" />
|
||||||
|
<meta
|
||||||
|
name="viewport"
|
||||||
|
content="width=device-width, initial-scale=1, shrink-to-fit=no"
|
||||||
|
/>
|
||||||
|
<meta name="theme-color" content="#000000" />
|
||||||
|
|
||||||
|
<!--
|
||||||
|
manifest.json provides metadata used when your web app is added to the
|
||||||
|
homescreen on Android. See https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/
|
||||||
|
-->
|
||||||
|
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Notice the use of %PUBLIC_URL% in the tags above.
|
||||||
|
It will be replaced with the URL of the `public` folder during the build.
|
||||||
|
Only files inside the `public` folder can be referenced from the HTML.
|
||||||
|
|
||||||
|
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
|
||||||
|
work correctly both with client-side routing and a non-root public URL.
|
||||||
|
Learn how to configure a non-root public URL by running `npm run build`.
|
||||||
|
-->
|
||||||
|
<title>react-component-form</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<noscript>
|
||||||
|
You need to enable JavaScript to run this app.
|
||||||
|
</noscript>
|
||||||
|
|
||||||
|
<div id="root"></div>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
This HTML file is a template.
|
||||||
|
If you open it directly in the browser, you will see an empty page.
|
||||||
|
|
||||||
|
You can add webfonts, meta tags, or analytics to this file.
|
||||||
|
The build step will place the bundled scripts into the <body> tag.
|
||||||
|
|
||||||
|
To begin the development, run `npm start` or `yarn start`.
|
||||||
|
To create a production bundle, use `npm run build` or `yarn build`.
|
||||||
|
-->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
15
example/public/manifest.json
Normal file
15
example/public/manifest.json
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"short_name": "react-component-form",
|
||||||
|
"name": "react-component-form",
|
||||||
|
"icons": [
|
||||||
|
{
|
||||||
|
"src": "favicon.ico",
|
||||||
|
"sizes": "64x64 32x32 24x24 16x16",
|
||||||
|
"type": "image/x-icon"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"start_url": ".",
|
||||||
|
"display": "standalone",
|
||||||
|
"theme_color": "#000000",
|
||||||
|
"background_color": "#ffffff"
|
||||||
|
}
|
||||||
BIN
example/src/github.jpg
Normal file
BIN
example/src/github.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
112
example/src/index.css
Normal file
112
example/src/index.css
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
*,
|
||||||
|
*::after,
|
||||||
|
*::before {
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
|
||||||
|
'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji',
|
||||||
|
'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji';
|
||||||
|
font-size: 1rem;
|
||||||
|
font-weight: 400;
|
||||||
|
line-height: 1.5;
|
||||||
|
color: #212529;
|
||||||
|
text-align: left;
|
||||||
|
background-color: #fff;
|
||||||
|
}
|
||||||
|
h1,
|
||||||
|
h2,
|
||||||
|
h3,
|
||||||
|
h4,
|
||||||
|
h5,
|
||||||
|
h6 {
|
||||||
|
font-weight: 500;
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
h2 {
|
||||||
|
font-size: 2rem;
|
||||||
|
}
|
||||||
|
h4 {
|
||||||
|
font-size: 1.5rem;
|
||||||
|
}
|
||||||
|
h5 {
|
||||||
|
font-size: 1.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.container {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
justify-content: center;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
.result-container {
|
||||||
|
border-top: 0.2px solid lightgray;
|
||||||
|
border-bottom: 0.2px solid lightgray;
|
||||||
|
width: 100%;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
.github-logo {
|
||||||
|
position: fixed;
|
||||||
|
top: 10px;
|
||||||
|
right: 10px;
|
||||||
|
}
|
||||||
|
.title-install {
|
||||||
|
color: gray;
|
||||||
|
margin-bottom: 50px;
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
form {
|
||||||
|
margin-bottom: 40px;
|
||||||
|
}
|
||||||
|
label {
|
||||||
|
display: inline-block;
|
||||||
|
margin-bottom: 0.5rem;
|
||||||
|
}
|
||||||
|
.form-group {
|
||||||
|
margin-bottom: 1rem;
|
||||||
|
}
|
||||||
|
.form-control {
|
||||||
|
display: block;
|
||||||
|
width: 100%;
|
||||||
|
height: calc(1.5em + 0.75rem + 2px);
|
||||||
|
padding: 0.375rem 0.75rem;
|
||||||
|
font-size: 1rem;
|
||||||
|
font-weight: 400;
|
||||||
|
line-height: 1.5;
|
||||||
|
color: #495057;
|
||||||
|
background-color: #fff;
|
||||||
|
background-clip: padding-box;
|
||||||
|
border: 1px solid #ced4da;
|
||||||
|
border-radius: 0.25rem;
|
||||||
|
transition: border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out;
|
||||||
|
}
|
||||||
|
.btn {
|
||||||
|
display: inline-block;
|
||||||
|
font-weight: 400;
|
||||||
|
color: #212529;
|
||||||
|
text-align: center;
|
||||||
|
vertical-align: middle;
|
||||||
|
-webkit-user-select: none;
|
||||||
|
user-select: none;
|
||||||
|
background-color: transparent;
|
||||||
|
border: 1px solid transparent;
|
||||||
|
padding: 0.375rem 0.75rem;
|
||||||
|
font-size: 1rem;
|
||||||
|
line-height: 1.5;
|
||||||
|
border-radius: 0.25rem;
|
||||||
|
transition: color 0.15s ease-in-out, background-color 0.15s ease-in-out,
|
||||||
|
border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
.btn-primary {
|
||||||
|
color: #fff;
|
||||||
|
background-color: #007bff;
|
||||||
|
border-color: #007bff;
|
||||||
|
}
|
||||||
|
.btn-primary:hover {
|
||||||
|
color: #fff;
|
||||||
|
background-color: #0069d9;
|
||||||
|
border-color: #0062cc;
|
||||||
|
}
|
||||||
63
example/src/index.tsx
Normal file
63
example/src/index.tsx
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
import React from 'react'
|
||||||
|
import ReactDOM from 'react-dom'
|
||||||
|
import Form, { HandleForm } from 'react-component-form'
|
||||||
|
|
||||||
|
import GithubLogo from './github.jpg'
|
||||||
|
import './index.css'
|
||||||
|
|
||||||
|
const App = () => {
|
||||||
|
const handleSubmit: HandleForm = (formData, formElement) => {
|
||||||
|
console.clear()
|
||||||
|
console.log('onSubmit: ', formData)
|
||||||
|
formElement.reset()
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleChange: HandleForm = (formData) => {
|
||||||
|
console.log('onChange: ', formData)
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className='container'>
|
||||||
|
<h2>{'<Form />'}</h2>
|
||||||
|
<h5 className='title-install'>npm i react-component-form</h5>
|
||||||
|
|
||||||
|
<Form onSubmit={handleSubmit} onChange={handleChange}>
|
||||||
|
<div className='form-group'>
|
||||||
|
<label htmlFor='name'>Name :</label>
|
||||||
|
<input
|
||||||
|
className='form-control'
|
||||||
|
type='text'
|
||||||
|
name='name'
|
||||||
|
id='name'
|
||||||
|
placeholder='name'
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button type='submit' className='btn btn-primary'>
|
||||||
|
Submit
|
||||||
|
</button>
|
||||||
|
</Form>
|
||||||
|
|
||||||
|
<div className='result-container'>
|
||||||
|
<h4>
|
||||||
|
Try the form and Inspect the console{' '}
|
||||||
|
<span role='img' aria-label='smiley'>
|
||||||
|
😃
|
||||||
|
</span>
|
||||||
|
</h4>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className='github-logo'>
|
||||||
|
<a
|
||||||
|
target='_blank'
|
||||||
|
rel='noopener noreferrer'
|
||||||
|
href='https://github.com/Divlo/react-component-form'
|
||||||
|
>
|
||||||
|
<img width='30px' alt='github' src={GithubLogo} />
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
ReactDOM.render(<App />, document.getElementById('root'))
|
||||||
1
example/src/react-app-env.d.ts
vendored
Normal file
1
example/src/react-app-env.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
/// <reference types="react-scripts" />
|
||||||
@ -1,3 +0,0 @@
|
|||||||
@tailwind base;
|
|
||||||
@tailwind components;
|
|
||||||
@tailwind utilities;
|
|
||||||
@ -1,20 +0,0 @@
|
|||||||
/** @type {import('tailwindcss').Config} */
|
|
||||||
const tailwindConfig = {
|
|
||||||
content: [
|
|
||||||
"./pages/**/*.{js,ts,jsx,tsx}",
|
|
||||||
"./components/**/*.{js,ts,jsx,tsx}",
|
|
||||||
],
|
|
||||||
darkMode: "class",
|
|
||||||
theme: {
|
|
||||||
extend: {
|
|
||||||
colors: {
|
|
||||||
black: "#212121",
|
|
||||||
success: "#45C85A",
|
|
||||||
error: "#C84545",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
plugins: [],
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = tailwindConfig
|
|
||||||
@ -1,21 +1,30 @@
|
|||||||
{
|
{
|
||||||
"extends": "@tsconfig/strictest/tsconfig.json",
|
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"target": "ESNext",
|
"outDir": "dist",
|
||||||
"module": "ESNext",
|
"module": "esnext",
|
||||||
"lib": ["dom", "dom.iterable", "ESNext"],
|
"lib": ["dom", "esnext", "DOM.Iterable"],
|
||||||
"allowJs": true,
|
|
||||||
"baseUrl": ".",
|
|
||||||
"types": ["cypress"],
|
|
||||||
"noEmit": true,
|
|
||||||
"moduleResolution": "node",
|
"moduleResolution": "node",
|
||||||
|
"jsx": "react",
|
||||||
|
"sourceMap": true,
|
||||||
|
"declaration": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"noImplicitReturns": true,
|
||||||
|
"noImplicitThis": true,
|
||||||
|
"noImplicitAny": true,
|
||||||
|
"strictNullChecks": true,
|
||||||
|
"suppressImplicitAnyIndexErrors": true,
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true,
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"target": "es5",
|
||||||
|
"allowJs": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"strict": true,
|
||||||
|
"forceConsistentCasingInFileNames": true,
|
||||||
"resolveJsonModule": true,
|
"resolveJsonModule": true,
|
||||||
"jsx": "preserve",
|
|
||||||
"incremental": true,
|
|
||||||
"exactOptionalPropertyTypes": false,
|
|
||||||
"verbatimModuleSyntax": false,
|
|
||||||
"isolatedModules": true,
|
"isolatedModules": true,
|
||||||
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
|
"include": ["src"],
|
||||||
"exclude": ["node_modules"],
|
"exclude": ["node_modules", "build"]
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"testEnvironment": "jsdom",
|
|
||||||
"rootDir": "./src",
|
|
||||||
"transform": {
|
|
||||||
"^.+\\.tsx?$": "esbuild-jest"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
35192
package-lock.json
generated
35192
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
113
package.json
113
package.json
@ -1,79 +1,74 @@
|
|||||||
{
|
{
|
||||||
"name": "react-component-form",
|
"name": "react-component-form",
|
||||||
"version": "0.0.0-development",
|
"version": "1.0.1",
|
||||||
"public": true,
|
|
||||||
"type": "module",
|
|
||||||
"description": "Manage React Forms with ease.",
|
"description": "Manage React Forms with ease.",
|
||||||
"author": "Théo LUDWIG <contact@theoludwig.fr>",
|
"author": "Divlo <contact@divlo.fr>",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
"files": [
|
||||||
|
"dist"
|
||||||
|
],
|
||||||
|
"main": "dist/index.js",
|
||||||
|
"module": "dist/index.modern.js",
|
||||||
|
"source": "src/index.tsx",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=10"
|
||||||
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/theoludwig/react-component-form.git"
|
"url": "git+https://github.com/Divlo/react-component-form.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"react-form",
|
"react-form",
|
||||||
"react-component-form"
|
"react-component-form"
|
||||||
],
|
],
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/theoludwig/react-component-form/issues"
|
"url": "https://github.com/Divlo/react-component-form/issues"
|
||||||
},
|
|
||||||
"homepage": "https://react-component-form.vercel.app/",
|
|
||||||
"main": "build/index.js",
|
|
||||||
"types": "build/index.d.ts",
|
|
||||||
"files": [
|
|
||||||
"build"
|
|
||||||
],
|
|
||||||
"publishConfig": {
|
|
||||||
"access": "public",
|
|
||||||
"provenance": true
|
|
||||||
},
|
},
|
||||||
|
"homepage": "https://github.com/Divlo/react-component-form#readme",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsup",
|
"build": "microbundle-crl --no-compress --format modern,cjs",
|
||||||
"test": "jest",
|
"start": "microbundle-crl watch --no-compress --format modern,cjs",
|
||||||
"lint:commit": "commitlint",
|
"prepare": "run-s build",
|
||||||
"lint:editorconfig": "editorconfig-checker",
|
"test": "run-s test:unit test:lint test:build",
|
||||||
"lint:markdown": "markdownlint-cli2",
|
"test:build": "run-s build",
|
||||||
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
|
"test:lint": "eslint ./**/*.{js,jsx,ts,tsx}",
|
||||||
"lint:prettier": "prettier . --check",
|
"test:unit": "cross-env CI=1 react-scripts test --env=jsdom",
|
||||||
"release": "semantic-release"
|
"test:watch": "react-scripts test --env=jsdom",
|
||||||
|
"predeploy": "cd example && npm install && npm run build",
|
||||||
|
"deploy": "gh-pages -d example/build"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"react": ">=18.2.0"
|
"react": "^16.0.0"
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"@sinclair/typebox": "0.32.13",
|
|
||||||
"ajv": "8.12.0",
|
|
||||||
"ajv-formats": "2.1.1"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "18.6.0",
|
"@testing-library/jest-dom": "^4.2.4",
|
||||||
"@commitlint/config-conventional": "18.6.0",
|
"@testing-library/react": "^9.5.0",
|
||||||
"@testing-library/react": "14.1.2",
|
"@testing-library/user-event": "^7.2.1",
|
||||||
"@tsconfig/strictest": "2.0.2",
|
"@types/jest": "^25.1.4",
|
||||||
"@types/jest": "29.5.11",
|
"@types/node": "^12.12.38",
|
||||||
"@types/react": "18.2.48",
|
"@types/react": "^16.9.27",
|
||||||
"@types/react-dom": "18.2.18",
|
"@types/react-dom": "^16.9.7",
|
||||||
"@typescript-eslint/eslint-plugin": "6.20.0",
|
"@typescript-eslint/eslint-plugin": "^2.26.0",
|
||||||
"@typescript-eslint/parser": "6.20.0",
|
"@typescript-eslint/parser": "^2.26.0",
|
||||||
"editorconfig-checker": "5.1.2",
|
"microbundle-crl": "^0.13.10",
|
||||||
"esbuild": "0.20.0",
|
"babel-eslint": "^10.0.3",
|
||||||
"esbuild-jest": "0.5.0",
|
"cross-env": "^7.0.2",
|
||||||
"eslint": "8.56.0",
|
"eslint": "^6.8.0",
|
||||||
"eslint-config-conventions": "13.1.0",
|
"eslint-config-prettier": "^6.7.0",
|
||||||
"eslint-config-prettier": "9.1.0",
|
"eslint-config-standard": "^14.1.0",
|
||||||
"eslint-plugin-import": "2.29.1",
|
"eslint-config-standard-react": "^9.2.0",
|
||||||
"eslint-plugin-prettier": "5.1.3",
|
"eslint-plugin-import": "^2.18.2",
|
||||||
"eslint-plugin-promise": "6.1.1",
|
"eslint-plugin-node": "^11.0.0",
|
||||||
"eslint-plugin-unicorn": "50.0.1",
|
"eslint-plugin-prettier": "^3.1.1",
|
||||||
"jest": "29.7.0",
|
"eslint-plugin-promise": "^4.2.1",
|
||||||
"jest-environment-jsdom": "29.7.0",
|
"eslint-plugin-react": "^7.17.0",
|
||||||
"markdownlint-cli2": "0.12.1",
|
"eslint-plugin-standard": "^4.0.1",
|
||||||
"markdownlint-rule-relative-links": "2.2.0",
|
"gh-pages": "^2.2.0",
|
||||||
"prettier": "3.2.4",
|
"npm-run-all": "^4.1.5",
|
||||||
"react": "18.2.0",
|
"prettier": "^2.0.4",
|
||||||
"react-dom": "18.2.0",
|
"react": "^16.13.1",
|
||||||
"semantic-release": "23.0.0",
|
"react-dom": "^16.13.1",
|
||||||
"tsup": "8.0.1",
|
"react-scripts": "^3.4.1",
|
||||||
"typescript": "5.3.3"
|
"typescript": "^3.7.5"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,42 +0,0 @@
|
|||||||
import React from "react"
|
|
||||||
import { render, cleanup, fireEvent } from "@testing-library/react"
|
|
||||||
|
|
||||||
import type { HandleForm } from ".."
|
|
||||||
import { Form } from ".."
|
|
||||||
|
|
||||||
afterEach(cleanup)
|
|
||||||
|
|
||||||
describe("<Form />", () => {
|
|
||||||
it("should get the formData and formElement onSubmit and onChange", () => {
|
|
||||||
let formData: { [k: string]: any } = {}
|
|
||||||
let formElement: any = null
|
|
||||||
const handleSubmitChange: HandleForm = (data, element) => {
|
|
||||||
formData = data
|
|
||||||
formElement = element
|
|
||||||
}
|
|
||||||
const formComponent = render(
|
|
||||||
<Form onSubmit={handleSubmitChange} onChange={handleSubmitChange}>
|
|
||||||
<input data-testid="input-form" type="text" name="inputName" />
|
|
||||||
<button data-testid="button-submit" type="submit">
|
|
||||||
Submit
|
|
||||||
</button>
|
|
||||||
</Form>,
|
|
||||||
)
|
|
||||||
const inputForm = formComponent.getByTestId(
|
|
||||||
"input-form",
|
|
||||||
) as HTMLInputElement
|
|
||||||
const buttonSubmit = formComponent.getByTestId("button-submit")
|
|
||||||
const text = "some random text"
|
|
||||||
|
|
||||||
fireEvent.change(inputForm, { target: { value: text } })
|
|
||||||
expect(formData["inputName"]).toEqual(text)
|
|
||||||
expect(formElement instanceof HTMLFormElement).toBeTruthy()
|
|
||||||
formData = {}
|
|
||||||
formElement = null
|
|
||||||
|
|
||||||
fireEvent.click(buttonSubmit)
|
|
||||||
expect(Object.keys(formData).length).toEqual(1)
|
|
||||||
expect(formData["inputName"]).toEqual(text)
|
|
||||||
expect(formElement instanceof HTMLFormElement).toBeTruthy()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@ -1,59 +0,0 @@
|
|||||||
import React, { useRef } from "react"
|
|
||||||
|
|
||||||
export interface FormDataObject {
|
|
||||||
[key: string]: FormDataEntryValue
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param formData Object where the keys are the name of your inputs and the current value.
|
|
||||||
* @param formElement The HTML form element in the DOM.
|
|
||||||
*/
|
|
||||||
export type HandleForm = (
|
|
||||||
formData: FormDataObject,
|
|
||||||
formElement: HTMLFormElement,
|
|
||||||
) => void | Promise<void>
|
|
||||||
|
|
||||||
interface ReactFormProps
|
|
||||||
extends Omit<React.HTMLProps<HTMLFormElement>, "onSubmit" | "onChange"> {}
|
|
||||||
|
|
||||||
export interface FormProps extends ReactFormProps {
|
|
||||||
onSubmit?: HandleForm
|
|
||||||
onChange?: HandleForm
|
|
||||||
}
|
|
||||||
|
|
||||||
export const getFormDataObject = (
|
|
||||||
formElement: HTMLFormElement,
|
|
||||||
): FormDataObject => {
|
|
||||||
return Object.fromEntries<FormDataEntryValue>(new FormData(formElement))
|
|
||||||
}
|
|
||||||
|
|
||||||
export const Form: React.FC<FormProps> = (props) => {
|
|
||||||
const { onSubmit, onChange, children, ...rest } = props
|
|
||||||
const formRef = useRef<HTMLFormElement>(null)
|
|
||||||
|
|
||||||
const handleSubmit = async (event: React.FormEvent): Promise<void> => {
|
|
||||||
event.preventDefault()
|
|
||||||
if (onSubmit != null) {
|
|
||||||
const formData = getFormDataObject(formRef.current as HTMLFormElement)
|
|
||||||
await onSubmit(formData, formRef.current as HTMLFormElement)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const handleChange = async (): Promise<void> => {
|
|
||||||
if (onChange != null) {
|
|
||||||
const formData = getFormDataObject(formRef.current as HTMLFormElement)
|
|
||||||
await onChange(formData, formRef.current as HTMLFormElement)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<form
|
|
||||||
ref={formRef}
|
|
||||||
onSubmit={handleSubmit}
|
|
||||||
onChange={handleChange}
|
|
||||||
{...rest}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</form>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
9
src/fromEntries.ts
Normal file
9
src/fromEntries.ts
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
/*! fromentries. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
|
||||||
|
export function fromEntries<T = any> (
|
||||||
|
iterable: Iterable<readonly [PropertyKey, T]>
|
||||||
|
) {
|
||||||
|
return [...iterable].reduce((object, [key, value]) => {
|
||||||
|
object[key] = value
|
||||||
|
return object
|
||||||
|
}, {})
|
||||||
|
}
|
||||||
@ -1,15 +0,0 @@
|
|||||||
import { useState } from "react"
|
|
||||||
|
|
||||||
export const fetchState = ["idle", "loading", "error", "success"] as const
|
|
||||||
|
|
||||||
export type FetchState = (typeof fetchState)[number]
|
|
||||||
|
|
||||||
export const useFetchState = (
|
|
||||||
initialFetchState: FetchState = "idle",
|
|
||||||
): [
|
|
||||||
fetchState: FetchState,
|
|
||||||
setFetchState: React.Dispatch<React.SetStateAction<FetchState>>,
|
|
||||||
] => {
|
|
||||||
const [fetchState, setFetchState] = useState<FetchState>(initialFetchState)
|
|
||||||
return [fetchState, setFetchState]
|
|
||||||
}
|
|
||||||
@ -1,166 +0,0 @@
|
|||||||
import { useMemo, useState } from "react"
|
|
||||||
import type { Static, TObject } from "@sinclair/typebox"
|
|
||||||
import { Type } from "@sinclair/typebox"
|
|
||||||
import type { ErrorObject } from "ajv"
|
|
||||||
|
|
||||||
import type { HandleForm } from "../components/Form"
|
|
||||||
import type { FetchState } from "./useFetchState"
|
|
||||||
import { useFetchState } from "./useFetchState"
|
|
||||||
import { ajv } from "../utils/ajv"
|
|
||||||
import { handleCheckboxBoolean } from "../utils/handleCheckboxBoolean"
|
|
||||||
import { handleOptionalEmptyStringToNull } from "../utils/handleOptionalEmptyStringToNull"
|
|
||||||
|
|
||||||
export interface Schema {
|
|
||||||
[property: string | symbol]: any
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Error = ErrorObject
|
|
||||||
|
|
||||||
export type ErrorsObject<K extends Schema> = {
|
|
||||||
[key in keyof Partial<K>]: Error[] | undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
export type HandleUseFormCallbackResult<K extends Schema> = Message<K> | null
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param formData Object where the keys are the name of your inputs and the current value.
|
|
||||||
* @param formElement The HTML form element in the DOM.
|
|
||||||
* @returns The return can be either `null` or an object with a global message of type `'error' | 'success'`.
|
|
||||||
*/
|
|
||||||
export type HandleUseFormCallback<K extends Schema> = (
|
|
||||||
formData: Static<TObject<K>>,
|
|
||||||
formElement: HTMLFormElement,
|
|
||||||
) => Promise<HandleUseFormCallbackResult<K>> | HandleUseFormCallbackResult<K>
|
|
||||||
|
|
||||||
export type HandleUseForm<K extends Schema> = (
|
|
||||||
callback?: HandleUseFormCallback<K>,
|
|
||||||
) => HandleForm
|
|
||||||
|
|
||||||
export interface GlobalMessage {
|
|
||||||
type: "error" | "success"
|
|
||||||
message?: string
|
|
||||||
properties?: undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface PropertiesMessage<K extends Schema> {
|
|
||||||
type: "error"
|
|
||||||
message?: string
|
|
||||||
properties: { [key in keyof Partial<K>]: string }
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Message<K extends Schema> = GlobalMessage | PropertiesMessage<K>
|
|
||||||
|
|
||||||
export interface UseFormResult<K extends Schema> {
|
|
||||||
/**
|
|
||||||
* Function to be used with the `onSubmit` or `onChange` prop of the `<Form />` component.
|
|
||||||
*/
|
|
||||||
handleUseForm: HandleUseForm<K>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The current state of the form.
|
|
||||||
*/
|
|
||||||
readonly fetchState: FetchState
|
|
||||||
setFetchState: React.Dispatch<React.SetStateAction<FetchState>>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Global message of the form (not specific to a property).
|
|
||||||
*/
|
|
||||||
readonly message: string | undefined
|
|
||||||
setMessage: React.Dispatch<React.SetStateAction<string | undefined>>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Object of errors:
|
|
||||||
* - Key: correspond to a property in the JSON Schema.
|
|
||||||
* - Value: array of {@link ErrorObject}.
|
|
||||||
*
|
|
||||||
* The array will always have at least one element (never empty) in case of errors.
|
|
||||||
*
|
|
||||||
* If the value is `undefined`, it means there are no errors for this property.
|
|
||||||
*/
|
|
||||||
readonly errors: ErrorsObject<K>
|
|
||||||
}
|
|
||||||
|
|
||||||
export const useForm = <K extends Schema>(
|
|
||||||
validationSchema: K,
|
|
||||||
): UseFormResult<typeof validationSchema> => {
|
|
||||||
const validationSchemaObject = useMemo(() => {
|
|
||||||
return Type.Object(validationSchema)
|
|
||||||
}, [validationSchema])
|
|
||||||
|
|
||||||
const [fetchState, setFetchState] = useFetchState()
|
|
||||||
const [message, setMessage] = useState<string | undefined>(undefined)
|
|
||||||
const [errors, setErrors] = useState<ErrorsObject<typeof validationSchema>>(
|
|
||||||
{} as any,
|
|
||||||
)
|
|
||||||
|
|
||||||
const validate = useMemo(() => {
|
|
||||||
return ajv.compile(validationSchemaObject)
|
|
||||||
}, [validationSchemaObject])
|
|
||||||
|
|
||||||
const handleUseForm: HandleUseForm<typeof validationSchema> = (callback) => {
|
|
||||||
return async (formData, formElement) => {
|
|
||||||
setErrors({} as any)
|
|
||||||
setMessage(undefined)
|
|
||||||
formData = handleOptionalEmptyStringToNull(
|
|
||||||
formData,
|
|
||||||
validationSchemaObject.required,
|
|
||||||
)
|
|
||||||
formData = handleCheckboxBoolean(formData, validationSchemaObject)
|
|
||||||
const isValid = validate(formData)
|
|
||||||
if (!isValid) {
|
|
||||||
setFetchState("error")
|
|
||||||
const errors: ErrorsObject<typeof validationSchema> = {} as any
|
|
||||||
for (const property in validationSchemaObject.properties) {
|
|
||||||
const errorsForProperty = validate.errors?.filter((error) => {
|
|
||||||
return error.instancePath === `/${property}`
|
|
||||||
})
|
|
||||||
errors[property as keyof typeof validationSchema] =
|
|
||||||
errorsForProperty != null && errorsForProperty.length > 0
|
|
||||||
? errorsForProperty
|
|
||||||
: undefined
|
|
||||||
}
|
|
||||||
setErrors(errors)
|
|
||||||
} else {
|
|
||||||
setErrors({} as any)
|
|
||||||
if (callback != null) {
|
|
||||||
setFetchState("loading")
|
|
||||||
const message = await callback(
|
|
||||||
formData as Static<TObject<typeof validationSchema>>,
|
|
||||||
formElement,
|
|
||||||
)
|
|
||||||
if (message != null) {
|
|
||||||
const { message: messageValue, type, properties } = message
|
|
||||||
setMessage(messageValue)
|
|
||||||
setFetchState(type)
|
|
||||||
if (type === "error") {
|
|
||||||
const propertiesErrors: ErrorsObject<typeof validationSchema> =
|
|
||||||
{} as any
|
|
||||||
for (const property in properties) {
|
|
||||||
propertiesErrors[property] = [
|
|
||||||
{
|
|
||||||
keyword: "message",
|
|
||||||
message: properties[property],
|
|
||||||
instancePath: `/${property}`,
|
|
||||||
schemaPath: `#/properties/${property}/message`,
|
|
||||||
params: {},
|
|
||||||
data: formData[property],
|
|
||||||
},
|
|
||||||
]
|
|
||||||
}
|
|
||||||
setErrors(propertiesErrors)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
handleUseForm,
|
|
||||||
fetchState,
|
|
||||||
setFetchState,
|
|
||||||
message,
|
|
||||||
setMessage,
|
|
||||||
errors,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
export * from "./components/Form"
|
|
||||||
export * from "./hooks/useFetchState"
|
|
||||||
export * from "./hooks/useForm"
|
|
||||||
export * from "./utils/ajv"
|
|
||||||
58
src/index.tsx
Normal file
58
src/index.tsx
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
import React, { useRef } from 'react'
|
||||||
|
import { fromEntries } from './fromEntries'
|
||||||
|
|
||||||
|
export interface FormDataObject {
|
||||||
|
[key: string]: FormDataEntryValue
|
||||||
|
}
|
||||||
|
|
||||||
|
export type HandleForm = (
|
||||||
|
formData: FormDataObject,
|
||||||
|
formElement: HTMLFormElement
|
||||||
|
) => void
|
||||||
|
|
||||||
|
type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
|
||||||
|
|
||||||
|
interface ReactFormProps
|
||||||
|
extends Omit<React.HTMLProps<HTMLFormElement>, 'onSubmit' | 'onChange'> {}
|
||||||
|
|
||||||
|
interface FormProps extends ReactFormProps {
|
||||||
|
onSubmit?: HandleForm
|
||||||
|
onChange?: HandleForm
|
||||||
|
}
|
||||||
|
|
||||||
|
const getFormDataObject = (formElement: HTMLFormElement): FormDataObject => {
|
||||||
|
return fromEntries<FormDataEntryValue>(new FormData(formElement))
|
||||||
|
}
|
||||||
|
|
||||||
|
const Form = (props: FormProps): JSX.Element => {
|
||||||
|
const { onSubmit, onChange, children, ...rest } = props
|
||||||
|
const formRef = useRef<HTMLFormElement>(null)
|
||||||
|
|
||||||
|
const handleSubmit = (event: React.FormEvent): void => {
|
||||||
|
event.preventDefault()
|
||||||
|
if (onSubmit != null) {
|
||||||
|
const formData = getFormDataObject(formRef.current as HTMLFormElement)
|
||||||
|
onSubmit(formData, formRef.current as HTMLFormElement)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleChange = (): void => {
|
||||||
|
if (onChange != null) {
|
||||||
|
const formData = getFormDataObject(formRef.current as HTMLFormElement)
|
||||||
|
onChange(formData, formRef.current as HTMLFormElement)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<form
|
||||||
|
ref={formRef}
|
||||||
|
onSubmit={handleSubmit}
|
||||||
|
onChange={handleChange}
|
||||||
|
{...rest}
|
||||||
|
>
|
||||||
|
{children}
|
||||||
|
</form>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
export default Form
|
||||||
18
src/typings.d.ts
vendored
Normal file
18
src/typings.d.ts
vendored
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
/**
|
||||||
|
* Default CSS definition for typescript,
|
||||||
|
* will be overridden with file-specific definitions by rollup
|
||||||
|
*/
|
||||||
|
declare module '*.css' {
|
||||||
|
const content: { [className: string]: string }
|
||||||
|
export default content
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SvgrComponent
|
||||||
|
extends React.StatelessComponent<React.SVGAttributes<SVGElement>> {}
|
||||||
|
|
||||||
|
declare module '*.svg' {
|
||||||
|
const svgUrl: string
|
||||||
|
const svgComponent: SvgrComponent
|
||||||
|
export default svgUrl
|
||||||
|
export { svgComponent as ReactComponent }
|
||||||
|
}
|
||||||
@ -1,25 +0,0 @@
|
|||||||
import addFormats from "ajv-formats"
|
|
||||||
import Ajv from "ajv"
|
|
||||||
|
|
||||||
export const ajv = addFormats(
|
|
||||||
new Ajv({
|
|
||||||
allErrors: true,
|
|
||||||
verbose: true,
|
|
||||||
}),
|
|
||||||
[
|
|
||||||
"date-time",
|
|
||||||
"time",
|
|
||||||
"date",
|
|
||||||
"email",
|
|
||||||
"hostname",
|
|
||||||
"ipv4",
|
|
||||||
"ipv6",
|
|
||||||
"uri",
|
|
||||||
"uri-reference",
|
|
||||||
"uuid",
|
|
||||||
"uri-template",
|
|
||||||
"json-pointer",
|
|
||||||
"relative-json-pointer",
|
|
||||||
"regex",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
import type { TObject } from "@sinclair/typebox"
|
|
||||||
|
|
||||||
import type { Schema } from "../hooks/useForm"
|
|
||||||
|
|
||||||
export const handleCheckboxBoolean = (
|
|
||||||
object: Schema,
|
|
||||||
validateSchemaObject: TObject<Schema>,
|
|
||||||
): Schema => {
|
|
||||||
const booleanProperties: string[] = []
|
|
||||||
for (const property in validateSchemaObject.properties) {
|
|
||||||
const rule = validateSchemaObject.properties[property]
|
|
||||||
if (rule.type === "boolean") {
|
|
||||||
booleanProperties.push(property)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for (const booleanProperty of booleanProperties) {
|
|
||||||
if (object[booleanProperty] == null) {
|
|
||||||
object[booleanProperty] =
|
|
||||||
validateSchemaObject.properties[booleanProperty].default
|
|
||||||
} else {
|
|
||||||
object[booleanProperty] = object[booleanProperty] === "on"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return object
|
|
||||||
}
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
import type { Schema } from "../hooks/useForm"
|
|
||||||
|
|
||||||
export const handleOptionalEmptyStringToNull = <K extends Schema>(
|
|
||||||
object: K,
|
|
||||||
required: string[] = [],
|
|
||||||
): K => {
|
|
||||||
return Object.fromEntries(
|
|
||||||
Object.entries(object).map(([key, value]) => {
|
|
||||||
if (
|
|
||||||
typeof value === "string" &&
|
|
||||||
value.length === 0 &&
|
|
||||||
!required.includes(key)
|
|
||||||
) {
|
|
||||||
return [key, null]
|
|
||||||
}
|
|
||||||
return [key, value]
|
|
||||||
}),
|
|
||||||
) as K
|
|
||||||
}
|
|
||||||
@ -1,15 +1,24 @@
|
|||||||
{
|
{
|
||||||
"extends": "@tsconfig/strictest/tsconfig.json",
|
|
||||||
"include": ["src", "types"],
|
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"module": "ESNext",
|
"outDir": "dist",
|
||||||
"lib": ["ESNext", "DOM", "DOM.Iterable"],
|
"module": "esnext",
|
||||||
"importHelpers": false,
|
"target": "ES3",
|
||||||
"declaration": true,
|
"lib": ["dom", "esnext", "DOM.Iterable"],
|
||||||
"sourceMap": true,
|
|
||||||
"rootDir": "./src",
|
|
||||||
"moduleResolution": "node",
|
"moduleResolution": "node",
|
||||||
"jsx": "react",
|
"jsx": "react",
|
||||||
"noEmit": true,
|
"sourceMap": true,
|
||||||
|
"declaration": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"noImplicitReturns": true,
|
||||||
|
"noImplicitThis": true,
|
||||||
|
"noImplicitAny": true,
|
||||||
|
"strictNullChecks": true,
|
||||||
|
"suppressImplicitAnyIndexErrors": true,
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true,
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"downlevelIteration": true
|
||||||
},
|
},
|
||||||
|
"include": ["src"],
|
||||||
|
"exclude": ["node_modules", "dist", "example"]
|
||||||
}
|
}
|
||||||
|
|||||||
6
tsconfig.test.json
Normal file
6
tsconfig.test.json
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"extends": "./tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"module": "commonjs"
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,13 +0,0 @@
|
|||||||
import { defineConfig } from "tsup"
|
|
||||||
|
|
||||||
export default defineConfig({
|
|
||||||
entry: ["src/**/*.{ts,tsx}", "!src/**/*.test.{ts,tsx}"],
|
|
||||||
sourcemap: false,
|
|
||||||
clean: true,
|
|
||||||
platform: "browser",
|
|
||||||
target: "esnext",
|
|
||||||
format: ["esm"],
|
|
||||||
minify: false,
|
|
||||||
outDir: "build",
|
|
||||||
dts: true,
|
|
||||||
})
|
|
||||||
Reference in New Issue
Block a user