mirror of
https://github.com/discourse/discourse.git
synced 2024-12-24 12:46:30 +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>
```
114 lines
2.5 KiB
SCSS
114 lines
2.5 KiB
SCSS
.d-toggle-switch {
|
|
--toggle-switch-width: 45px;
|
|
--toggle-switch-height: 24px;
|
|
|
|
&:focus {
|
|
.d-toggle-switch__checkbox-slider {
|
|
outline: 2px solid var(--tertiary);
|
|
outline-offset: 2px;
|
|
}
|
|
}
|
|
|
|
&:hover {
|
|
.d-toggle-switch__checkbox-slider {
|
|
background-color: var(--primary-high);
|
|
}
|
|
|
|
.d-toggle-switch__checkbox[aria-checked="true"]:not([disabled])
|
|
+ .d-toggle-switch__checkbox-slider {
|
|
background-color: var(--tertiary-hover);
|
|
}
|
|
}
|
|
|
|
display: flex;
|
|
align-items: center;
|
|
gap: 0.5rem;
|
|
|
|
&__label {
|
|
position: relative;
|
|
display: inline-block;
|
|
cursor: pointer;
|
|
margin: 0;
|
|
}
|
|
|
|
&__checkbox {
|
|
position: absolute;
|
|
border: 0;
|
|
padding: 0;
|
|
background: transparent;
|
|
|
|
&:focus {
|
|
+ .d-toggle-switch__checkbox-slider {
|
|
outline: 2px solid var(--tertiary);
|
|
outline-offset: 2px;
|
|
}
|
|
|
|
// Outline should show only when tabbing, not clicking
|
|
&:not(:focus-visible) {
|
|
+ .d-toggle-switch__checkbox-slider {
|
|
outline: none;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
&__checkbox[aria-checked="true"] + .d-toggle-switch__checkbox-slider {
|
|
background-color: var(--tertiary);
|
|
}
|
|
|
|
&__checkbox[aria-checked="true"] + .d-toggle-switch__checkbox-slider::before {
|
|
left: calc(var(--toggle-switch-width) - 22px);
|
|
}
|
|
|
|
&__checkbox[disabled] + .d-toggle-switch__checkbox-slider {
|
|
opacity: 0.5;
|
|
cursor: not-allowed;
|
|
|
|
&::before {
|
|
cursor: not-allowed;
|
|
}
|
|
}
|
|
|
|
&__checkbox-slider {
|
|
display: inline-block;
|
|
cursor: pointer;
|
|
background: var(--primary-low-mid);
|
|
border-radius: var(--toggle-switch-height);
|
|
width: var(--toggle-switch-width);
|
|
height: var(--toggle-switch-height);
|
|
position: relative;
|
|
vertical-align: middle;
|
|
transition: background 0.25s;
|
|
|
|
.d-icon {
|
|
font-size: var(--font-down-1);
|
|
color: var(--secondary);
|
|
left: 7px;
|
|
top: 6px;
|
|
position: absolute;
|
|
}
|
|
}
|
|
|
|
&__checkbox-slider::before,
|
|
&__checkbox-slider::after {
|
|
content: "";
|
|
display: block;
|
|
position: absolute;
|
|
cursor: pointer;
|
|
}
|
|
|
|
&__checkbox-slider::before {
|
|
background: var(--secondary);
|
|
border-radius: 50%;
|
|
width: calc(var(--toggle-switch-height) * 0.75);
|
|
height: calc(var(--toggle-switch-height) * 0.75);
|
|
top: calc(var(--toggle-switch-height) * 0.125);
|
|
left: calc(var(--toggle-switch-height) * 0.125);
|
|
transition: left 0.25s;
|
|
|
|
@media (prefers-reduced-motion: reduce) {
|
|
transition-duration: 0ms;
|
|
}
|
|
}
|
|
}
|