Atoms / Segmented

Segmented

A switch between a few views or modes of the same thing.

import { Segmented } from "@forgeron/ui";
/01 → Views
import { Segmented } from "@forgeron/ui";
import { useState } from "react";

export default function Views() {
  const [view, setView] = useState("board");
  return (
    <Segmented
      label="View"
      value={view}
      onChange={setView}
      options={[
        { value: "list", label: "List" },
        { value: "board", label: "Board" },
        { value: "calendar", label: "Calendar" },
      ]}
    />
  );
}
/02 → Icons
import { GridViewIcon, Menu01Icon } from "@forgeron/icons";
import { Icon, Segmented } from "@forgeron/ui";
import { useState } from "react";

export default function Icons() {
  const [view, setView] = useState("grid");
  return (
    <Segmented
      label="Layout"
      iconOnly
      value={view}
      onChange={setView}
      options={[
        { value: "grid", label: <Icon icon={GridViewIcon} size={12} />, ariaLabel: "Grid" },
        { value: "list", label: <Icon icon={Menu01Icon} size={12} />, ariaLabel: "List" },
      ]}
    />
  );
}
API → Props
PropTypeDefaultDescription
labelstring—Names the group, e.g. View.
options{ value, label, ariaLabel? }[]—The segments.
valuestring—The chosen one.
onChange(value: string) => void—On a click.
iconOnlyboolean—Square segments for icons.
classNamestring—Extra classes.