Skip to content

A platform for community discussion. Free, open, simple.

DEV: New component: segmented control (#38242)

chapoi2a53237e2c8a
diff --git a/app/assets/stylesheets/common/base/discourse.scss b/app/assets/stylesheets/common/base/discourse.scss
index 5a762d1f3a6..38e267c20c0 100644
--- a/app/assets/stylesheets/common/base/discourse.scss
+++ b/app/assets/stylesheets/common/base/discourse.scss
@@ -319,7 +319,7 @@ label {
align-items: flex-start;
color: var(--primary-high);
- &:not(.checkbox-label) {
+ &:not(.checkbox-label, .d-segmented-control__label) {
font-weight: bold;
}
diff --git a/app/assets/stylesheets/common/components/_index.scss b/app/assets/stylesheets/common/components/_index.scss
index 202c3990af7..804c04d1a31 100644
--- a/app/assets/stylesheets/common/components/_index.scss
+++ b/app/assets/stylesheets/common/components/_index.scss
@@ -10,6 +10,7 @@
@import "bookmark-modal";
@import "bookmark-menu";
@import "buttons";
+@import "d-segmented-control";
@import "d-select";
@import "color-input";
@import "char-counter";
diff --git a/app/assets/stylesheets/common/components/d-segmented-control.scss b/app/assets/stylesheets/common/components/d-segmented-control.scss
new file mode 100644
index 00000000000..1eba72f7462
--- /dev/null
+++ b/app/assets/stylesheets/common/components/d-segmented-control.scss
@@ -0,0 +1,85 @@
+.d-segmented-control {
+ position: relative;
+ display: inline-flex;
+ align-items: center;
+ background: var(--primary-very-low);
+ gap: var(--space-2);
+ border-radius: var(--d-border-radius-large);
+ padding: var(--space-1) var(--space-2);
+
+ &__legend {
+ position: absolute;
+ width: 1px;
+ height: 1px;
+ padding: 0;
+ margin: 0;
+ overflow: hidden;
+ clip-path: inset(50%);
+ white-space: nowrap;
+ }
+
+ &__slider {
+ position: absolute;
+ top: var(--space-1);
+ left: 0;
+ width: var(--slider-width, 0);
+ height: var(--space-9);
+ transform: translateX(var(--slider-x, 0));
+ background: var(--secondary);
+ border-radius: var(--d-border-radius-large);
+ box-shadow: 0 1px 6px rgb(0, 0, 0, 0.1);
+ pointer-events: none;
+
+ &.is-animated {
+ transition:
+ transform 0.25s cubic-bezier(0.4, 0, 0.2, 1),
+ width 0.25s cubic-bezier(0.4, 0, 0.2, 1);
+
+ @media (prefers-reduced-motion: reduce) {
+ transition-duration: 0ms;
+ }
+ }
+ }
+
+ &__input[type="radio"] {
+ position: absolute;
+ width: 1px;
+ height: 1px;
+ padding: 0;
+ margin: 0;
+ overflow: hidden;
+ clip-path: inset(50%);
+ }
+
+ &__label {
+ z-index: 1;
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ font-weight: normal;
+ padding: var(--space-1) var(--space-4);
+ margin: 0;
+ border-radius: var(--d-border-radius-large);
+ color: var(--primary-high);
+ height: var(--space-7);
+ cursor: pointer;
+ user-select: none;
+ white-space: nowrap;
+
+ &:hover {
+ background: var(--primary-low);
+ color: var(--primary);
+ }
+
+ &:has(:focus-visible) {
+ outline: 2px solid var(--tertiary);
+ outline-offset: -2px;
+ }
+
+ &:has(:checked),
+ &:has(:checked):hover {
+ background: transparent;
+ color: var(--primary);
+ }
+ }
+}
diff --git a/frontend/discourse/app/components/d-segmented-control.gjs b/frontend/discourse/app/components/d-segmented-control.gjs
new file mode 100644
index 00000000000..e740d8e958f
--- /dev/null
+++ b/frontend/discourse/app/components/d-segmented-control.gjs
@@ -0,0 +1,75 @@
+import Component from "@glimmer/component";
+import { fn } from "@ember/helper";
+import { on } from "@ember/modifier";
+import { action } from "@ember/object";
+import { modifier as modifierFn } from "ember-modifier";
+import { eq } from "discourse/truth-helpers";
+import { i18n } from "discourse-i18n";
+
+export default class DSegmentedControl extends Component {
+ positionSlider = modifierFn((element, [value]) => {
+ if (!value) {
+ return;
+ }
+
+ const checked = element.querySelector("input:checked");
+ if (!checked) {
+ return;
+ }
+
+ const slider = element.querySelector(".d-segmented-control__slider");
+ const label = checked.closest(".d-segmented-control__label");
+ const frameId = requestAnimationFrame(() => {
+ element.style.setProperty("--slider-x", `${label.offsetLeft}px`);
+ element.style.setProperty("--slider-width", `${label.offsetWidth}px`);
+
+ if (!slider.classList.contains("is-animated")) {
+ requestAnimationFrame(() => slider.classList.add("is-animated"));
+ }
+ });
+
+ return () => cancelAnimationFrame(frameId);
+ });
+
+ get legend() {
+ if (this.args.label) {
+ return i18n(this.args.label);
+ }
+ return this.args.translatedLabel;
+ }
+
+ @action
+ handleChange(value) {
+ this.args.onSelect?.(value);
+ }
+
+ <template>
+ <fieldset
+ class="d-segmented-control"
+ {{this.positionSlider @value}}
+ ...attributes
+ >
+ {{#if this.legend}}
+ <legend class="d-segmented-control__legend">
+ {{this.legend}}
+ </legend>
+ {{/if}}
+
+ <span class="d-segmented-control__slider"></span>
+
+ {{#each @items as |item|}}
+ <label class="d-segmented-control__label">
+ <input
+ type="radio"
+ name={{@name}}
+ value={{item.value}}
+ checked={{eq @value item.value}}
+ class="d-segmented-control__input"
+ {{on "change" (fn this.handleChange item.value)}}
+ />
+ <span class="d-segmented-control__text">{{item.label}}</span>
+ </label>
+ {{/each}}
+ </fieldset>
+ </template>
+}
diff --git a/frontend/discourse/tests/integration/components/d-segmented-control-test.gjs b/frontend/discourse/tests/integration/components/d-segmented-control-test.gjs
new file mode 100644
index 00000000000..c23c4d98397
--- /dev/null
+++ b/frontend/discourse/tests/integration/components/d-segmented-control-test.gjs
@@ -0,0 +1,75 @@
+import { click, render } from "@ember/test-helpers";
+import { module, test } from "qunit";
+import DSegmentedControl from "discourse/components/d-segmented-control";
+import { setupRenderingTest } from "discourse/tests/helpers/component-test";
+import I18n, { i18n } from "discourse-i18n";
+
+module("Integration | Component | d-segmented-control", function (hooks) {
+ setupRenderingTest(hooks);
+
+ const ITEMS = [
+ { value: "day", label: "Day" },
+ { value: "week", label: "Week" },
+ { value: "month", label: "Month" },
+ ];
+
+ test("renders checked state and updates on click", async function (assert) {
+ this.set("selected", "week");
+ const handleSelect = (value) => this.set("selected", value);
+
+ await render(
+ <template>
+ <DSegmentedControl
+ @name="period"
+ @items={{ITEMS}}
+ @value={{this.selected}}
+ @onSelect={{handleSelect}}
+ />
+ </template>
+ );
+
+ assert.dom(".d-segmented-control__input[value='day']").isNotChecked();
+ assert.dom(".d-segmented-control__input[value='week']").isChecked();
+ assert.dom(".d-segmented-control__input[value='month']").isNotChecked();
+
+ await click(".d-segmented-control__label:nth-child(4)");
+
+ assert.dom(".d-segmented-control__input[value='day']").isNotChecked();
+ assert.dom(".d-segmented-control__input[value='week']").isNotChecked();
+ assert.dom(".d-segmented-control__input[value='month']").isChecked();
+ });
+
+ test("@label renders an accessible legend", async function (assert) {
+ I18n.translations[I18n.locale].js.test = { periodLabel: "Time period" };
+
+ await render(
+ <template>
+ <DSegmentedControl
+ @name="period"
+ @items={{ITEMS}}
+ @value="day"
+ @label="test.periodLabel"
+ />
+ </template>
+ );
+
+ assert
+ .dom(".d-segmented-control__legend")
+ .hasText(i18n("test.periodLabel"));
+ });
+
+ test("@translatedLabel renders an accessible legend", async function (assert) {
+ await render(
+ <template>
+ <DSegmentedControl
+ @name="period"
+ @items={{ITEMS}}
+ @value="day"
+ @translatedLabel="Time period"
+ />
+ </template>
+ );
+
+ assert.dom(".d-segmented-control__legend").hasText("Time period");
+ });
+});
diff --git a/plugins/styleguide/assets/javascripts/discourse/components/sections/molecules/segmented-control.gjs b/plugins/styleguide/assets/javascripts/discourse/components/sections/molecules/segmented-control.gjs
new file mode 100644
index 00000000000..4c0bb5bfca4
--- /dev/null
+++ b/plugins/styleguide/assets/javascripts/discourse/components/sections/molecules/segmented-control.gjs
@@ -0,0 +1,46 @@
+import Component from "@glimmer/component";
+import { tracked } from "@glimmer/tracking";
+import { action } from "@ember/object";
+import DSegmentedControl from "discourse/components/d-segmented-control";
+import StyleguideExample from "discourse/plugins/styleguide/discourse/components/styleguide-example";
+
+export default class SegmentedControl extends Component {
+ @tracked value1 = "week";
+
+ items1 = [
+ { value: "day", label: "Day" },
+ { value: "week", label: "Week" },
+ { value: "month", label: "Month" },
+ { value: "year", label: "Year" },
+ { value: "all", label: "All" },
+ ];
+
+ get basicCode() {
+ return `import DSegmentedControl from "discourse/components/d-segmented-control";
+
+<template>
+ <DSegmentedControl
+ @name="time-period"
+ @items={{this.items}}
+ @value={{this.selected}}
+ @onSelect={{this.handleSelect}}
+ />
+</template>`;
+ }
+
+ @action
+ onSelect1(value) {
+ this.value1 = value;
+ }
+
+ <template>
+ <StyleguideExample @title="<DSegmentedControl>" @code={{this.basicCode}}>
+ <DSegmentedControl
+ @name="time-period"
+ @items={{this.items1}}
+ @value={{this.value1}}
+ @onSelect={{this.onSelect1}}
+ />
+ </StyleguideExample>
+ </template>
+}
diff --git a/plugins/styleguide/assets/javascripts/discourse/lib/styleguide.js b/plugins/styleguide/assets/javascripts/discourse/lib/styleguide.js
index 03dfd374cbc..354cacd16d1 100644
--- a/plugins/styleguide/assets/javascripts/discourse/lib/styleguide.js
+++ b/plugins/styleguide/assets/javascripts/discourse/lib/styleguide.js
@@ -19,6 +19,7 @@ import multiselect from "../components/sections/molecules/multi-select";
import navigationBar from "../components/sections/molecules/navigation-bar";
import navigationStacked from "../components/sections/molecules/navigation-stacked";
import postMenu from "../components/sections/molecules/post-menu";
+import segmentedControl from "../components/sections/molecules/segmented-control";
import signupCta from "../components/sections/molecules/signup-cta";
import toasts from "../components/sections/molecules/toasts";
import tooltips from "../components/sections/molecules/tooltips";
@@ -62,6 +63,11 @@ const SECTIONS = [
{ component: dateTimeInputs, category: "atoms", id: "date-time-inputs" },
{ component: dropdowns, category: "atoms", id: "dropdowns" },
{ component: topicLink, category: "atoms", id: "topic-link" },
+ {
+ component: segmentedControl,
+ category: "atoms",
+ id: "segmented-control",
+ },
{ component: breadCrumbs, category: "molecules", id: "bread-crumbs" },
{ component: categories, category: "molecules", id: "categories" },
{ component: charCounter, category: "molecules", id: "char-counter" },
diff --git a/plugins/styleguide/config/locales/client.en.yml b/plugins/styleguide/config/locales/client.en.yml
index ffdebf51027..5859e31d0c3 100644
--- a/plugins/styleguide/config/locales/client.en.yml
+++ b/plugins/styleguide/config/locales/client.en.yml
@@ -113,3 +113,5 @@ en:
char_counter:
title: "Character Counter"
placeholder: "Enter your text here..."
+ segmented_control:
+ title: "Segmented Control (Button toggle group)"
diff --git a/plugins/styleguide/spec/system/smoke_test_spec.rb b/plugins/styleguide/spec/system/smoke_test_spec.rb
index fd00d46fbd6..990e185ff73 100644
--- a/plugins/styleguide/spec/system/smoke_test_spec.rb
+++ b/plugins/styleguide/spec/system/smoke_test_spec.rb
@@ -18,6 +18,7 @@ RSpec.describe "Styleguide Smoke Test", type: :system do
{ href: "/atoms/date-time-inputs", title: "Date/Time inputs" },
{ href: "/atoms/dropdowns", title: "Dropdowns" },
{ href: "/atoms/topic-link", title: "Topic Link and Status" },
+ { href: "/atoms/segmented-control", title: "Segmented Control (Button toggle group)" },
],
"MOLECULES" => [
{ href: "/molecules/bread-crumbs", title: "Bread Crumbs" },