Skip to content

Commit

Permalink
docs: document validator combinators
Browse files Browse the repository at this point in the history
refactor!: soft-deprecate `compose` combinator
  • Loading branch information
willothy committed Mar 28, 2024
1 parent 62cae59 commit 1b742f4
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/pages/docs/components/form.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ n.form(

#### on_submit

<Property
<Property
defaultValue="fn.ignore"
types={['fun(is_valid: boolean): nil']}
/>

#### submit_key

<Property
<Property
defaultValue="<C-CR>"
types={['string[]', 'string']}
/>
Expand All @@ -63,4 +63,11 @@ Available validation functions:
- `equals`
- `contains`

Available combinators:

- `all`: ensures all validators pass
- `any`: ensures at least one validator passes
- `none`: ensures no validators pass
- `compose` (deprecated, use `all`)


0 comments on commit 1b742f4

Please sign in to comment.