mirror of
https://github.com/discourse/discourse.git
synced 2024-12-02 15:34:20 +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>
```
54 lines
1.4 KiB
JavaScript
54 lines
1.4 KiB
JavaScript
import Component from "@glimmer/component";
|
|
import { escapeExpression } from "discourse/lib/utilities";
|
|
import I18n from "discourse-i18n";
|
|
|
|
export default class BadgePreview extends Component {
|
|
get processedSample() {
|
|
return this.args.model.badge.sample.map((grant) => {
|
|
let i18nKey = "admin.badges.preview.grant.with";
|
|
const i18nParams = { username: escapeExpression(grant.username) };
|
|
|
|
if (grant.post_id) {
|
|
i18nKey += "_post";
|
|
i18nParams.link = `<a href="/p/${grant.post_id}" data-auto-route="true">
|
|
${escapeExpression(grant.title)}
|
|
</a>`;
|
|
}
|
|
|
|
if (grant.granted_at) {
|
|
i18nKey += "_time";
|
|
i18nParams.time = escapeExpression(
|
|
moment(grant.granted_at).format(I18n.t("dates.long_with_year"))
|
|
);
|
|
}
|
|
|
|
return I18n.t(i18nKey, i18nParams);
|
|
});
|
|
}
|
|
|
|
get countWarning() {
|
|
if (this.args.model.badge.grant_count <= 10) {
|
|
return (
|
|
this.args.model.badge.sample.length !==
|
|
this.args.model.badge.grant_count
|
|
);
|
|
} else {
|
|
return this.args.model.badge.sample?.length !== 10;
|
|
}
|
|
}
|
|
|
|
get hasQueryPlan() {
|
|
return !!this.args.model.badge.query_plan;
|
|
}
|
|
|
|
get queryPlanHtml() {
|
|
let output = `<pre>`;
|
|
this.args.model.badge.query_plan.forEach((linehash) => {
|
|
output += escapeExpression(linehash["QUERY PLAN"]);
|
|
output += "<br>";
|
|
});
|
|
output += "</pre>";
|
|
return output;
|
|
}
|
|
}
|