Skip to main content

ModUI

class
class ModUI

Import

import { ModUI } from '@modular/sdk/mod-ui';

Members13

disposables
() => void[]
host
ModUIHost<'tabs' | 'sessions' | 'viewDefinitions' | 'viewContainers' | 'views'>
props
Props
self
ReadonlySignal<Anchor>
computed
<T>(fn: () => T) => ReadonlySignal<T> | <T>(name: string, fn: () => T) => ReadonlySignal<T>

Create a computed signal owned by this component. In dev builds, the signal-name-loader automatically injects the property name so devtools can identify it.

dispose
() => void
effect
(fn: () => void | () => void) => () => void

Create a tracked side effect that auto-disposes on component disposal. The callback is auto-tracked -- any signal read inside it becomes a dependency. When a dependency changes, the callback re-runs. The callback can return a cleanup function that runs before each re-execution and on disposal.

liveQuery
<TQuery extends QueryBuilder<Context>>(build: SpaceQueryBuilder<TQuery>) => ReadonlySignal<{ [K in string | number | symbol]: ResultValue<ExtractContext<TQuery>>[K] }[]>
registerDisposable
(dispose: () => void) => void
render
() => ReactNode
rows
<Family extends 'tabs' | 'sessions' | 'viewDefinitions' | 'viewContainers' | 'views'>(family: Family) => ReadonlySignal<SemanticRow<Family>[]>
signal
<T>(value: T) => Signal<T> | <T>(name: string, value: T) => Signal<T>

Create a signal owned by this component. In dev builds, the signal-name-loader automatically injects the property name so devtools can identify it. You can also pass the name explicitly.

tableFor
<Row extends object, Key extends string | number>(token: CollectionToken<Row, Key>) => Collection<Row, Key>