Skip to content

Home › Overview › ink

ui_labs_story ​

Wraps a component as a UI Labs story.

Types ​

Cleanup type ​

luau
type Cleanup = () -> ()

GenericInfo type ​

luau
type GenericInfo<T> = { __old: T, __new: T }

SubscribeListener type ​

luau
type SubscribeListener = (values: { [string]: unknown }, info: { [string]: GenericInfo<unknown> }) -> ()

GenericProperties type ​

luau
type GenericProperties = {
	controls: { [string]: unknown },
	target: GuiObject,
	converted: { [string]: unknown },
	subscribe: (listener: SubscribeListener) -> Cleanup,
}

GenericStory type ​

luau
type GenericStory<C = nil> = {
	name: string?,
	summary: string?,
	cleanup: Cleanup?,
	controls: C?,
	render: (properties: GenericProperties) -> Cleanup?,
}

Functions ​

ui_labs_story ​

luau
ui_labs_story<C>(story: types.Story<C>): GenericStory<C>