Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme #13

Merged
merged 2 commits into from Apr 27, 2022
Merged

Update readme #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccd6f81
Add some fields to the package.json file
daleal Apr 27, 2022
195593f
Add a list of available components
daleal Apr 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -98,6 +98,16 @@ const submit = async () => {

Each validation corresponds to a function that receives the value in the input and returns `true` (if the value of the input is correct) or an error string. Each validation will be run _sequentially_ from the first validation of the array to the last one, and the first validation to fail will be displayed as the error.

## Available Components

The available components are listed below:

- `LForm`: The form wrapper that validates inputs when trying to submit.
- `LInput`: A validatable `input` component.
- `LTextarea`: A validatable `textarea` component.
- `LCheckbox`: A `checkbox` type `input` component that plays nicely with the `LCheckboxGroup` component.
- `LCheckboxGroup`: A validatable group of `LCheckbox` components.

## Development

### Testing locally
Expand Down
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Expand Up @@ -2,7 +2,9 @@
"name": "loveform",
"version": "0.2.0",
"description": "The Vue form assembly tool that won't break your heart 💔",
"homepage": "https://loveform.daleal.dev",
"repository": "https://github.com/daleal/loveform",
"bugs": "https://github.com/daleal/loveform/issues",
"license": "MIT",
"author": {
"name": "Daniel Leal",
Expand Down