close
Programmatically closes HoverIntent immediately, invalidating pending transitions and suppressing reopening until the trigger disengages.
close: (model: Model) => UpdateReturnEffect-native UI toolkit
Interactive demosPublished API · 0.1.0-rc.1
Published themes API declarations for components/hover-card.
@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/hover-card'closeProgrammatically closes HoverIntent immediately, invalidating pending transitions and suppressing reopening until the trigger disengages.
close: (model: Model) => UpdateReturnembedembed: <ParentMessage>(h: HtmlBuilder<ParentMessage>, config: EmbedConfig<ParentMessage>) => HtmlEmbedConfigexport type EmbedConfig<Message> = Readonly<{
slotId: string;
id: string;
model: UiHoverIntent.Model;
toParentMessage: (message: UiHoverIntent.Message) => Message;
viewInputs: ViewInputs<Message>;
}>;foldfold: <ParentModel, ParentMessage, ParentOutMessage>(config: Omit<Update.ChildFoldWithDerivedParentOutMessage<ParentModel, ParentMessage, UiHoverIntent.Model, UiHoverIntent.Message, UiHoverIntent.Message, UiHoverIntent.OutMessage, ParentOutMessage>, 'update'>) => Update.FoldWithOutMessage<ParentModel, ParentMessage, UiHoverIntent.Message, ParentOutMessage>initinit: (config?: Parameters<typeof UiHoverIntent.init>[0]) => UiHoverIntent.ModelMessageexport type Message = typeof Message.Type;MessageUnion of all Messages the HoverIntent component can produce.
Message: import("@wsagency/wseffect-foldkit/message").MessageUnion<{
readonly EnteredTrigger: {};
readonly LeftTrigger: {};
readonly EnteredPanel: {};
readonly LeftPanel: {};
readonly FocusedTrigger: {};
readonly BlurredTrigger: {};
readonly FocusedPanel: {};
readonly BlurredPanel: {};
readonly PressedEscape: {
source: Schema.Literals<readonly ["Trigger", "Panel"]>;
};
readonly CompletedWaitBeforeOpening: {
version: Schema.Number;
};
readonly CompletedWaitBeforeClosing: {
version: Schema.Number;
};
}>Modelexport type Model = typeof Model.Type;ModelSchema for HoverIntent state. It tracks pointer and focus engagement over a trigger and its panel, visibility, delay timers, and Escape dismissal.
Model: Schema.Struct<{
readonly isOpen: Schema.Boolean;
readonly isTriggerHovered: Schema.Boolean;
readonly isPanelHovered: Schema.Boolean;
readonly maybeFocusLocation: Schema.Option<Schema.Literals<readonly ["Trigger", "Panel"]>>;
readonly isDismissed: Schema.Boolean;
readonly openDelay: Schema.DurationFromMillis;
readonly closeDelay: Schema.DurationFromMillis;
readonly pendingOpenVersion: Schema.Number;
readonly pendingCloseVersion: Schema.Number;
}>OutMessageexport type OutMessage = typeof OutMessage.Type;OutMessageUnion of visibility-transition OutMessages emitted by HoverIntent.
OutMessage: import("@wsagency/wseffect-foldkit/message").MessageUnion<{
readonly Opened: {};
readonly Closed: {};
}>updateProcesses a HoverIntent Message and returns the next Model, optional Commands, and an optional OutMessage.
update: (model: Model, message: Message) => UpdateReturnViewInputsexport type ViewInputs<Message> = Readonly<{
id: string;
anchor?: AnchorConfig;
triggerHref?: string;
trigger: ReadonlyArray<Html | string>;
content: ReadonlyArray<Html | string>;
}>;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.HoverCard.embed(h, { slotId: 'profile-card-example', id: 'profile-card-example', model: Themes.HoverCard.init(), toParentMessage: (message) => message, viewInputs: { id: 'profile-card-example', trigger: ['Jordan Doe'], content: ['Product designer'] } })