Documentation navigation

Foldkit UI

Foldkit UI

Accessible stateful controls for applications using the Foldkit core.

@wsagency/wseffect-foldkit-ui provides accessible stateful UI components as public subpath exports. Install alongside Foldkit and its required Effect peers: pnpm add @wsagency/wseffect-foldkit-ui@0.1.0-rc.1 @wsagency/wseffect-foldkit@0.1.0-rc.1 effect@^4.0.5 @effect/platform-browser@^4.0.5.

For example, the button subpath exports its view:

import { view } from '@wsagency/wseffect-foldkit-ui/button'

Consult each generated subpath reference for the real declaration and required inputs; do not assume every component has the same state or event contract. This is an independently maintained snapshot of upstream @foldkit/ui@0.168.0; see migration from upstream.

Package entry point

@wsagency/wseffect-foldkit-ui · MIT · source · MIT license · WS-AGENCY-NOTICE · THIRD-PARTY-NOTICES

This entry point is published in @wsagency/wseffect-foldkit-ui@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-foldkit-ui'

Exported declarations

Anchor

export { anchorSetup, portalBackdrop, portalToContainingRoot, AnchorConfig, Placement, Padding, } from './index.js';
export type { SetupConfig } from './index.js';

Animation

export { init, show, hide, update, toggle, view, defaultLeaveCommand, Model, Message, OutMessage, type Showed, type Hid, TransitionState, WaitForPaint, WaitForAnimationSettled, } from './index.js';
export type { InitConfig, ViewInputs } from './index.js';

Button

export { view } from './index.js';
export type { ViewConfig, ButtonAttributes } from './index.js';

Calendar

export { init, update, view, selectDate, focusDate, reflectMinDate, reflectMaxDate, reflectDisabledDates, reflectDisabledDaysOfWeek, dropToDays, Model, ViewMode, Message, OutMessage, type ChangedViewMonth, type SelectedDate, type ClickedDay, type PressedKeyOnGrid, type SelectedMonth, type SelectedYear, FocusGrid, } from './index.js';
export type { InitConfig, ViewInputs, ViewLabels, CalendarAttributes, DaysModeAttributes, MonthsModeAttributes, YearsModeAttributes, DayCell, ColumnHeader, Week, MonthCell, YearCell, } from './index.js';

Checkbox

export { view, labelId, descriptionId } from './index.js';
export type { ViewConfig, CheckboxAttributes } from './index.js';

Combobox

export { init, create, Model } from './single.js';
export { inputId } from './shared.js';
export { Message, OutMessage, type Selected, type ClearedSelection, type SelectedItem, type CompletedLockScroll, type CompletedUnlockScroll, type CompletedInertOthers, type CompletedRestoreInert, type CompletedFocusInput, type CompletedScrollIntoView, type CompletedClickItem, AnchorCombobox, AttachComboboxPreventBlur, AttachComboboxSelectOnFocus, PortalComboboxBackdrop, LockScroll, UnlockScroll, InertOthers, RestoreInert, FocusInput, ScrollIntoView, ClickItem, DetectMovementOrAnimationEnd, type Opened, type Closed, type BlurredInput, type ActivatedItem, type DeactivatedItem, type MovedPointerOverItem, type RequestedItemClick, type SuppressedItemCommit, type SuppressedEmptyItemNavigation, type UpdatedInputValue, type PressedToggleButton, } from './shared.js';
export type { ActivationTrigger, ItemConfig, GroupHeading, BaseViewInputsCommon, } from './shared.js';
export type { Bundle, InitConfig, ViewInputs } from './single.js';
export type { AnchorConfig } from '../anchor/index.js';
export * as Multi from './multiPublic.js';

DatePicker

export { init, update, view, triggerId, open, close, selectDate, clear, focusDate, reflectMinDate, reflectMaxDate, reflectDisabledDates, reflectDisabledDaysOfWeek, Model, Message, OutMessage, type SelectedDate, type ClearedDate, type ChangedViewMonth, } from './index.js';
export type { InitConfig, ViewInputs } from './index.js';

Dialog

export { init, boot, update, open, close, view, titleId, descriptionId, Model, Message, OutMessage, type Opened, type Closed, type RequestedOpen, type RequestedClose, type SucceededShowDialog, type FailedShowDialog, type SucceededAcquireResources, type FailedAcquireResources, type CompletedCloseDialog, type Unmounted, type CompletedReleaseDialogResources, ShowDialog, AcquireResources, CloseDialog, ReleaseDialogResources, } from './index.js';
export type { InitConfig, ViewInputs, RenderInfo } from './index.js';

Disclosure

export { view, buttonId } from './index.js';
export type { ViewConfig, DisclosureAttributes, AnimatePanelOptions, } from './index.js';

DragAndDrop

export { init, update, draggable, droppable, sortable, ghostStyle, isDragging, maybeDraggedItemId, maybeDropTarget, subscriptions, DragState, Model, Message, OutMessage, FocusItem, ResolveKeyboardMove, } from './index.js';
export type { InitConfig, DraggableConfig, DraggableMessage } from './index.js';

Fieldset

export { view, legendId, descriptionId } from './index.js';
export type { ViewConfig, FieldsetAttributes } from './index.js';

FileDrop

export { init, update, view, Model, Message, OutMessage } from './index.js';
export type { InitConfig, ViewInputs, FileDropAttributes } from './index.js';

HoverIntent

export { close, init, update, view, Model, Message, OutMessage, type BlurredPanel, type BlurredTrigger, type Closed, type CompletedWaitBeforeClosing, type CompletedWaitBeforeOpening, type EnteredPanel, type EnteredTrigger, type FocusedPanel, type FocusedTrigger, type LeftPanel, type LeftTrigger, type Opened, type PressedEscape, WaitBeforeClosing, WaitBeforeOpening, } from './index.js';
export type { InitConfig, RenderInfo, ViewInputs } from './index.js';

Input

export { view, descriptionId } from './index.js';
export type { ViewConfig, InputAttributes } from './index.js';

Listbox

export { init, create, Model } from './single.js';
export { buttonId } from './shared.js';
export { Message, OutMessage, type Selected, Orientation, type SelectedItem, AnchorListbox, PortalListboxBackdrop, type CompletedDelayClearSearch, LockScroll, UnlockScroll, InertOthers, RestoreInert, FocusButton, FocusItems, ScrollIntoView, ClickItem, DelayClearSearch, DetectMovementOrAnimationEnd, type Opened, type Closed, type BlurredItems, type ActivatedItem, type DeactivatedItem, type MovedPointerOverItem, type RequestedItemClick, type Searched, type PressedPointerOnButton, type IgnoredMouseClick, type SuppressedSpaceScroll, type SuppressedItemCommit, } from './shared.js';
export type { ActivationTrigger, ItemConfig, GroupHeading, BaseViewInputsCommon, ItemToValueInput, } from './shared.js';
export type { Bundle, InitConfig, ViewInputs } from './single.js';
export type { AnchorConfig } from '../anchor/index.js';
export * as Multi from './multiPublic.js';

Menu

export { init, create, Model, openAt, buttonId, Message, OutMessage, type Selected, type SelectedItem, AnchorMenu, PortalMenuBackdrop, ContextSourceEvents, ContextMenuAnchor, ContextLongPress, contextTriggerAttributes, FocusButton, FocusSource, LockScroll, UnlockScroll, InertOthers, RestoreInert, FocusItems, ScrollIntoView, ClickItem, DelayClearSearch, DetectMovementOrAnimationEnd, type Closed, type BlurredItems, type ActivatedItem, type DeactivatedItem, type MovedPointerOverItem, type RequestedItemClick, type Searched, type PressedPointerOnButton, type ReleasedPointerOnItems, type IgnoredMouseClick, type SuppressedSpaceScroll, } from './index.js';
export { ContextInvocationSchema, OpenedAtSchema, LongPressExpiredSchema, SourceUnmountedSchema, } from './index.js';
export type { ContextInvocation } from './index.js';
export type { ActivationTrigger, InitConfig, ViewInputs, ItemConfig, GroupHeading, Bundle, CompletedDelayClearSearch, Opened, } from './index.js';
export type { AnchorConfig } from '../anchor/index.js';
export { createContextMenu } from './context.js';
export type { ContextMenuBundle, ContextMenuClasses, ContextMenuConfig, ContextMenuEntry, ContextMenuGroup, ContextMenuItem, ContextMenuSeparator, } from './context.js';

Meter

export { view, labelId } from './index.js';
export type { ViewConfig, MeterAttributes } from './index.js';

Nav

export { view } from './index.js';
export type { ItemInfo, RenderInfo, ViewInputs } from './index.js';

Popover

export { init, update, open, close, view, buttonId, arrowId, Model, Message, OutMessage, type Opened, type Closed, type RequestedOpen, type RequestedClose, AnchorPopover, PortalPopoverBackdrop, LockScroll, UnlockScroll, InertOthers, RestoreInert, FocusPanel, FocusButton, DetectMovementOrAnimationEnd, type BlurredPanel, type PressedPointerOnButton, type IgnoredMouseClick, type SuppressedSpaceScroll, } from './index.js';
export type { InitConfig, ViewInputs, RenderInfo } from './index.js';
export type { AnchorConfig } from '../anchor/index.js';

Progress

export { view, labelId } from './index.js';
export type { ViewConfig, ProgressAttributes } from './index.js';

RadioGroup

export { init, create, Model, Message, OutMessage, type Selected, type SelectedOption, type FocusedOption, FocusOption, Orientation, } from './index.js';
export type { InitConfig, ViewInputs, RenderInfo, OptionInfo, Bundle, } from './index.js';

Select

export { view, descriptionId } from './index.js';
export type { ViewConfig, SelectAttributes } from './index.js';

Slider

export { init, update, reflectRange, view, subscriptions, subscriptionsForRoot, fractionOfValue, snapAndClamp, valueFromPointer, Model, Message, Orientation, OutMessage, ThumbAlignment, type PressedThumb, type PressedPointer, type MovedDragPointer, type ReleasedDragPointer, type CancelledDrag, type PressedKeyboardNavigation, } from './index.js';
export type { InitConfig, ViewInputs, SliderAttributes } from './index.js';
export * as Range from './range.js';
export type { Thumb as RangeThumb, RangeConfig, RangeModel, RangeMessage, RangeOutMessage } from './range.js';

Switch

export { view, labelId, descriptionId } from './index.js';
export type { ViewConfig, SwitchAttributes } from './index.js';

Tabs

export { init, create, Model, Message, OutMessage, type Selected, type SelectedTab, type FocusedTab, FocusTab, Orientation, PanelMount, } from './index.js';
export type { ActivationMode, InitConfig, ViewInputs, RenderInfo, TabInfo, Bundle, } from './index.js';

Textarea

export { view, descriptionId } from './index.js';
export type { ViewConfig, TextareaAttributes } from './index.js';

Toast

export { make, Message, Variant, Position, SwipeDirection, SwipeState, DEFAULT_SWIPE_DIRECTION, DEFAULT_SWIPE_THRESHOLD, SWIPE_SETTLE_DURATION, swipeOffset, type Dismissed, type DismissedAll, type CompletedWaitBeforeDismissal, type HoveredEntry, type LeftEntry, type GotAnimationMessage, type PressedEntryPointer, type MovedSwipePointer, type ReleasedSwipePointer, type CancelledSwipe, type PressedEscape, type CompletedWaitForSwipeSettled, WaitBeforeDismissal, WaitForSwipeSettled, } from './index.js';
export * as test from './test.js';
export type { EntryHandlers } from './index.js';
export type { InitConfig, ShowInput, SwipeToDismissConfig } from './index.js';
export type { DrainEntryInput } from './test.js';

Tooltip

export { init, update, view, triggerId, reflectShowDelay, Model, Message, OutMessage, type Shown, type Hidden, type EnteredTrigger, type LeftTrigger, type FocusedTrigger, type BlurredTrigger, type PressedEscape, type PressedPointerOnTrigger, WaitBeforeShowing, AnchorTooltip, } from './index.js';
export type { InitConfig, ViewInputs, RenderInfo } from './index.js';
export type { AnchorConfig } from '../anchor/index.js';

VirtualList

export { init, update, renderedRange, informItemsChanged, scrollTo, scrollToEnd, scrollToIndex, scrollToKey, scrollToOffset, view, Model, Message, ContentAlignment, ScrollAlignment, ScrollTarget, } from './index.js';
export type { InitConfig, RowHeightInputs, ScrollToOptions, ViewInputs, } from './index.js';