Option
export type Option<Value extends string> = {
value: Value;
label: Html;
isDisabled?: boolean;
};Effect-native UI toolkit
Interactive demosPublished API · 0.1.0-rc.1
Published themes API declarations for components/checkbox-group.
@wsagency/wseffect-themes · MIT · source · MIT license · WS-AGENCY-NOTICE
This entry point is published in @wsagency/wseffect-themes@0.1.0-rc.1. Import it from the package subpath shown below; the signatures and documentation are read from the installed package declarations.
import * as Wseffect from '@wsagency/wseffect-themes/components/checkbox-group'Optionexport type Option<Value extends string> = {
value: Value;
label: Html;
isDisabled?: boolean;
};Propsexport type Props = typeof Props.Type;PropsProps: Schema.Struct<{
readonly id: Schema.String;
readonly size: Schema.optional<Schema.Union<readonly [Schema.Literals<readonly string[]> | Schema.String, Schema.Struct<{
[k: string]: Schema.optional<Schema.Literals<readonly string[]> | Schema.String>;
}>]>>;
readonly variant: Schema.optional<Schema.Literals<readonly ["classic", "surface", "soft"]>>;
readonly color: Schema.optional<Schema.Literals<readonly ["gray", "gold", "bronze", "brown", "yellow", "amber", "orange", "tomato", "red", "ruby", "crimson", "pink", "plum", "purple", "violet", "iris", "indigo", "blue", "cyan", "teal", "jade", "green", "grass", "lime", "mint", "sky", "custom"]>>;
readonly highContrast: Schema.optional<Schema.Boolean>;
readonly isDisabled: Schema.optional<Schema.Boolean>;
readonly ariaLabel: Schema.optional<Schema.String>;
}>viewview: <Value extends string, Message>(props: Props & {
label?: Html;
ariaLabel?: string;
options: ReadonlyArray<Option<Value>>;
selected: ReadonlySet<Value>;
toggleMessage(value: Value, isChecked: boolean): Message;
}, h: HtmlBuilder<Message>) => Html| Name | Type | Required | Choices | Description |
|---|---|---|---|---|
id | string | Yes | — | — |
size | "1" | "2" | "3" | Responsive<"1" | "2" | "3"> | No | — | — |
variant | "classic" | "surface" | "soft" | No | "classic", "surface", "soft" | — |
color | "gray" | "gold" | "bronze" | "brown" | "yellow" | "amber" | "orange" | "tomato" | "red" | "ruby" | "crimson" | "pink" | "plum" | "purple" | "violet" | "iris" | "indigo" | "blue" | "cyan" | "teal" | "jade" | "green" | "grass" | "lime" | "mint" | "sky" | "custom" | No | "gray", "gold", "bronze", "brown", "yellow", "amber", "orange", "tomato", "red", "ruby", "crimson", "pink", "plum", "purple", "violet", "iris", "indigo", "blue", "cyan", "teal", "jade", "green", "grass", "lime", "mint", "sky", "custom" | — |
highContrast | boolean | No | — | — |
isDisabled | boolean | No | — | — |
ariaLabel | string | No | — | — |
import * as Themes from '@wsagency/wseffect-themes'
import * as SliderRange from '@wsagency/wseffect-themes/components/slider/range'
import * as Option from 'effect/Option'
import { defineView } from '@wsagency/wseffect-foldkit/submodel'
import { inertHtml, type HtmlBuilder } from '@wsagency/wseffect-foldkit/html'
const example = (h: HtmlBuilder<unknown>) => Themes.CheckboxGroup.view({ id: 'notifications-example', options: [{ value: 'email', label: h.span([], ['Email']) }], selected: new Set(['email']), toggleMessage: (value, isChecked) => ({ value, isChecked }) }, h)