Documentation navigation

Published API · 0.1.0-rc.1

themes · components/text-field

Published themes API declarations for components/text-field.

./components/text-field

@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/text-field'

Exported declarations

Props

Props: Schema.Struct<{
    readonly id: Schema.String;
    readonly label: 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 radius: Schema.optional<Schema.Literals<readonly ["none", "small", "medium", "large", "full"]>>;
    readonly value: Schema.optional<Schema.String>;
    readonly placeholder: Schema.optional<Schema.String>;
    readonly type: Schema.optional<Schema.String>;
    readonly disabled: Schema.optional<Schema.Boolean>;
    readonly readOnly: Schema.optional<Schema.Boolean>;
    readonly invalid: Schema.optional<Schema.Boolean>;
    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"]>>;
}>

view

view: <Message>(props: ViewProps<Message>, children: ReadonlyArray<Html | string>, h: HtmlBuilder<Message>) => Html

ViewProps

export type ViewProps<Message> = typeof Props.Type & Readonly<{
    onInput?: (value: string) => Message;
    inputAttributes?: ReadonlyArray<Attribute<Message>>;
}>;

Props

Props exported by @wsagency/wseffect-themes/components/text-field · Props · source
NameTypeRequiredChoicesDescription
idstringYes——
labelstringYes——
size"1" | "2" | "3" | Responsive<"1" | "2" | "3">No——
variant"classic" | "surface" | "soft"No"classic", "surface", "soft"—
radius"none" | "small" | "medium" | "large" | "full"No"none", "small", "medium", "large", "full"—
valuestringNo——
placeholderstringNo——
typestringNo——
disabledbooleanNo——
readOnlybooleanNo——
invalidbooleanNo——
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"—

Rendered component example

TextField
Example usage
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.TextField.view({ id: 'email', label: 'Email', type: 'email', value: 'jordan@example.com', onInput: (value) => value }, [], h)