mirror of
https://github.com/discourse/discourse.git
synced 2024-12-16 02:03:45 +08:00
2ca06ba236
This PR introduces FormKit, a component-based form library designed to simplify form creation and management. This library provides a single `Form` component, various field components, controls, validation mechanisms, and customization options. Additionally, it includes helpers to facilitate testing and writing specifications for forms.
1. **Form Component**:
- The main component that encapsulates form logic and structure.
- Yields various utilities like `Field`, `Submit`, `Alert`, etc.
**Example Usage**:
```gjs
import Form from "discourse/form";
<template>
<Form as |form|>
<form.Field
@name="username"
@title="Username"
@validation="required"
as |field|
>
<field.Input />
</form.Field>
<form.Field @name="age" @title="Age" as |field|>
<field.Input @type="number" />
</form.Field>
<form.Submit />
</Form>
</template>
```
2. **Validation**:
- Built-in validation rules such as `required`, `number`, `length`, and `url`.
- Custom validation callbacks for more complex validation logic.
**Example Usage**:
```javascript
validateUsername(name, value, data, { addError }) {
if (data.bar / 2 === value) {
addError(name, "That's not how maths work.");
}
}
```
```hbs
<form.Field @name="username" @validate={{this.validateUsername}} />
```
3. **Customization**:
- Plugin outlets for extending form functionality.
- Styling capabilities through propagated attributes.
- Custom controls with properties provided by `form` and `field`.
**Example Usage**:
```hbs
<Form class="my-form" as |form|>
<form.Field class="my-field" as |field|>
<MyCustomControl id={{field.id}} @onChange={{field.set}} />
</form.Field>
</Form>
```
4. **Helpers for Testing**:
- Test assertions for form and field validation.
**Example usage**:
```javascript
assert.form().hasErrors("the form shows errors");
assert.form().field("foo").hasValue("bar", "user has set the value");
```
- Helper for interacting with he form
**Example usage**:
```javascript
await formKit().field("foo").fillIn("bar");
```
5. **Page Object for System Specs**:
- Page objects for interacting with forms in system specs.
- Methods for submitting forms, checking alerts, and interacting with fields.
**Example Usage**:
```ruby
form = PageObjects::Components::FormKit.new(".my-form")
form.submit
expect(form).to have_an_alert("message")
```
**Field Interactions**:
```ruby
field = form.field("foo")
expect(field).to have_value("bar")
field.fill_in("bar")
```
6. **Collections handling**:
- A specific component to handle array of objects
**Example Usage**:
```gjs
<Form @data={{hash foo=(array (hash bar=1) (hash bar=2))}} as |form|>
<form.Collection @name="foo" as |collection|>
<collection.Field @name="bar" @title="Bar" as |field|>
<field.Input />
</collection.Field>
</form.Collection>
</Form>
```
|
||
|---|---|---|
| .. | ||
| client.ar.yml | ||
| client.be.yml | ||
| client.bg.yml | ||
| client.bs_BA.yml | ||
| client.ca.yml | ||
| client.cs.yml | ||
| client.da.yml | ||
| client.de.yml | ||
| client.el.yml | ||
| client.en_GB.yml | ||
| client.en.yml | ||
| client.es.yml | ||
| client.et.yml | ||
| client.fa_IR.yml | ||
| client.fi.yml | ||
| client.fr.yml | ||
| client.gl.yml | ||
| client.he.yml | ||
| client.hr.yml | ||
| client.hu.yml | ||
| client.hy.yml | ||
| client.id.yml | ||
| client.it.yml | ||
| client.ja.yml | ||
| client.ko.yml | ||
| client.lt.yml | ||
| client.lv.yml | ||
| client.nb_NO.yml | ||
| client.nl.yml | ||
| client.pl_PL.yml | ||
| client.pt_BR.yml | ||
| client.pt.yml | ||
| client.ro.yml | ||
| client.ru.yml | ||
| client.sk.yml | ||
| client.sl.yml | ||
| client.sq.yml | ||
| client.sr.yml | ||
| client.sv.yml | ||
| client.sw.yml | ||
| client.te.yml | ||
| client.th.yml | ||
| client.tr_TR.yml | ||
| client.ug.yml | ||
| client.uk.yml | ||
| client.ur.yml | ||
| client.vi.yml | ||
| client.zh_CN.yml | ||
| client.zh_TW.yml | ||
| server.ar.yml | ||
| server.be.yml | ||
| server.bg.yml | ||
| server.bs_BA.yml | ||
| server.ca.yml | ||
| server.cs.yml | ||
| server.da.yml | ||
| server.de.yml | ||
| server.el.yml | ||
| server.en_GB.yml | ||
| server.en.yml | ||
| server.es.yml | ||
| server.et.yml | ||
| server.fa_IR.yml | ||
| server.fi.yml | ||
| server.fr.yml | ||
| server.gl.yml | ||
| server.he.yml | ||
| server.hr.yml | ||
| server.hu.yml | ||
| server.hy.yml | ||
| server.id.yml | ||
| server.it.yml | ||
| server.ja.yml | ||
| server.ko.yml | ||
| server.lt.yml | ||
| server.lv.yml | ||
| server.nb_NO.yml | ||
| server.nl.yml | ||
| server.pl_PL.yml | ||
| server.pt_BR.yml | ||
| server.pt.yml | ||
| server.ro.yml | ||
| server.ru.yml | ||
| server.sk.yml | ||
| server.sl.yml | ||
| server.sq.yml | ||
| server.sr.yml | ||
| server.sv.yml | ||
| server.sw.yml | ||
| server.te.yml | ||
| server.th.yml | ||
| server.tr_TR.yml | ||
| server.ug.yml | ||
| server.uk.yml | ||
| server.ur.yml | ||
| server.vi.yml | ||
| server.zh_CN.yml | ||
| server.zh_TW.yml | ||