Your next page is taking shape...

Opening Your Next Page…

Loading the guide and preparing its examples for you to explore. The page will appear here automatically when it’s ready, so you can keep this view open without refreshing.

Made for Preact. Built to be yours.

Navigation & Disclosure

Locale Segment Group

Locale Segment Group is a compact two-or-more-option control for switching UI language or similar string codes. Organize content into understandable destinations and reveal detail when it becomes relevant. Keep the active location or expanded state easy to recognize. Import it from @/components/kamod-ui/locale-segment-group.

Source · API reference · Theming · Styles


Interactive Live Preview
Try it. Make it yours.
Setting the scene...

Interactive preview

Live Preact example Local preview theme · Responsive styles follow the preview widthFull width

Installation

Import LocaleSegmentGroup from @/components/kamod-ui/locale-segment-group.

Install PackagesTerminal
pnpm add @kamod-ch/ui

Copy an example with @kamod-ch/ui or the matching @kamod-ch/ui/… subpath. The code block switches between those two installs. Connect The Global Theme CSS and Tailwind Source Detection before your first render.

Usage

Control value from your app state (for example editor getLocale / setLocale). Clicking the active segment does nothing; only changes call onValueChange.

Import SetupTypeScript
import { LocaleSegmentGroup } from "@kamod-ch/ui";

Choose a complete composition from the examples below; required child components and props vary by pattern.

Component Examples & Variants

Explore Locale Segment Group in Different Contexts, from the starting pattern to the compositions below. Begin with Basic DE / EN, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API Reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.

Read the Result and Its Implementation Together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the Component Styles Guide for hierarchy and the Theming Guide for shared surfaces and colors. The Accessibility Notes explain what to preserve when making those changes.

Basic DE / EN

Make the Active Language Explicit. Use LocaleSegmentGroup for a compact choice between locale values, with German and English as the default options. Pass value and onValueChange when the application owns the selected language and its translation updates.

Decide whether the preference persists across visits, and test longer translated labels elsewhere in the interface after switching between the available languages.

src/components/LocaleSegmentGroupExample.tsx7 lines
import { LocaleSegmentGroup } from "@kamod-ch/ui";
import { useState } from "preact/hooks";

export const Example = () => {
  const [value, setValue] = useState("de");
  return <LocaleSegmentGroup value={value} onValueChange={setValue} />;
};

Custom Options

Use Labels Your Audience Recognizes. Supply options to choose your own locale codes and visible labels. The active segment stays selected when clicked again, making the control represent one current locale rather than an independently toggleable set of languages.

Include a meaningful accessible name for the group, keep the active value valid when options change, and avoid using flags as the sole representation of language.

Interactive Live Preview
Try it. Make it yours.
Setting the scene...

Interactive preview

Live Preact example Local preview theme · Responsive styles follow the preview widthFull width
API reference

Props and Data

Configure Locale Segment Group using the contracts below. Read the documented options alongside the Source Definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.

Props, slots and variants for this component.

API reference
Your API, from source

Type cards are extracted from this checkout’s TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.

Component Props

Read each option with its owning component. The
marker identifies required fields verified in that declaration. A ? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.
@kamod-ch/ui/locale-segment-group1.9 KB min · 0.8 KB gzipSignals: none

LocaleSegmentGroup

LocaleSegmentGroupProps

LocaleSegmentGroup documented props
Prop / typeDescription
class
stringLocaleSegmentGroupProps

Configure class for LocaleSegmentGroup. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
onValueChange
(next: string) => voidLocaleSegmentGroupProps

Configure onValueChange for LocaleSegmentGroup. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
options
LocaleSegmentOption[]LocaleSegmentGroupProps

Configure options for LocaleSegmentGroup. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
value
stringLocaleSegmentGroupProps

Configure value for LocaleSegmentGroup. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—

Data Type Reference

Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the Implementation Source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.

LocaleSegmentOption

2 declared fields
LocaleSegmentOption
Exported Source Declaration from LocaleSegmentGroup.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of LocaleSegmentOption before adapting it.
Required fields
value, label

LocaleSegmentGroup Props

4 declared fields
LocaleSegmentGroupProps
Exported Source Declaration from LocaleSegmentGroup.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of LocaleSegmentGroupProps before adapting it.
Required fields
value, onValueChange

Accessibility

LocaleSegmentGroup renders a named group, defaulting to Language, and buttons whose aria-pressed reflects the selected locale. These are toggle-style buttons, not native radio inputs.

Take the Next Useful Step

You have the pieces. Put them into one real interaction, keep its state in one place, and check the result with the content your application will actually show.

Connect the Foundation

Return to Choose and Compose Components to connect this reference to a working screen. Keep global CSS in one entrypoint and import only the components that screen needs.

Build the Surrounding Screen

Find a neighboring interaction in the Component Library, or start with a complete Block. Replace sample content and destinations before refining the layout; a local class change can stay with the composition.

Make the Result Hold Up

Use shared theme roles for changes that belong everywhere. Then review the whole journey: keyboard focus, long labels, narrow screens and a clear way to recover when something fails.

Keep a link to the source and note your intentional changes. Your next edit should begin with a clear decision, not another search.