mirror of
https://github.com/discourse/discourse.git
synced 2024-12-12 21:34:16 +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>
```
92 lines
1.8 KiB
JavaScript
92 lines
1.8 KiB
JavaScript
export const FLOAT_UI_PLACEMENTS = [
|
|
"top",
|
|
"top-start",
|
|
"top-end",
|
|
"right",
|
|
"right-start",
|
|
"right-end",
|
|
"bottom",
|
|
"bottom-start",
|
|
"bottom-end",
|
|
"left",
|
|
"left-start",
|
|
"left-end",
|
|
];
|
|
|
|
export const TOOLTIP = {
|
|
options: {
|
|
animated: true,
|
|
arrow: true,
|
|
beforeTrigger: null,
|
|
closeOnClickOutside: true,
|
|
closeOnEscape: true,
|
|
closeOnScroll: true,
|
|
component: null,
|
|
content: null,
|
|
identifier: null,
|
|
interactive: false,
|
|
listeners: false,
|
|
maxWidth: 350,
|
|
data: null,
|
|
offset: 10,
|
|
triggers: ["hover", "click"],
|
|
untriggers: ["hover", "click"],
|
|
placement: "top",
|
|
fallbackPlacements: FLOAT_UI_PLACEMENTS,
|
|
autoUpdate: true,
|
|
trapTab: true,
|
|
onClose: null,
|
|
onShow: null,
|
|
onRegisterApi: null,
|
|
},
|
|
portalOutletId: "d-tooltip-portal-outlet",
|
|
};
|
|
|
|
export const MENU = {
|
|
options: {
|
|
animated: true,
|
|
arrow: false,
|
|
autofocus: false,
|
|
beforeTrigger: null,
|
|
closeOnEscape: true,
|
|
closeOnClickOutside: true,
|
|
closeOnScroll: false,
|
|
component: null,
|
|
content: null,
|
|
identifier: null,
|
|
interactive: true,
|
|
listeners: false,
|
|
maxWidth: 400,
|
|
data: null,
|
|
offset: 10,
|
|
triggers: ["click"],
|
|
untriggers: ["click"],
|
|
placement: "bottom-start",
|
|
fallbackPlacements: FLOAT_UI_PLACEMENTS,
|
|
autoUpdate: true,
|
|
trapTab: true,
|
|
onClose: null,
|
|
onShow: null,
|
|
onRegisterApi: null,
|
|
modalForMobile: false,
|
|
inline: null,
|
|
groupIdentifier: null,
|
|
triggerClass: null,
|
|
contentClass: null,
|
|
class: null,
|
|
},
|
|
portalOutletId: "d-menu-portal-outlet",
|
|
};
|
|
|
|
import DDefaultToast from "float-kit/components/d-default-toast";
|
|
|
|
export const TOAST = {
|
|
options: {
|
|
autoClose: true,
|
|
duration: 3000,
|
|
component: DDefaultToast,
|
|
showProgressBar: false,
|
|
views: ["desktop", "mobile"],
|
|
},
|
|
};
|