ILayoutProvide
interface
Layout & Sizing
Internal provide/inject contract exposed by OrigamLayout to its registered layout items — do not use directly in application code.
TypeScript
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- registerrequis( vm: ComponentInternalInstance, options: { id: string order: Ref<number> position: Ref<TDirectionBoth> layoutSize: Ref<number | string> elementSize: Ref<number | string | undefined> active: Ref<boolean> disableTransitions?: Ref<boolean> absolute: Ref<boolean | undefined> } ) => { layoutItemStyles: Ref<CSSProperties> layoutItemScrimStyles: Ref<CSSProperties> zIndex: Ref<number> }
- Called by useLayoutItem to register a new docked item and receive reactive style refs.
- unregisterrequis(id: string) => void
- Removes a previously registered item from the layout.
- mainRectrequisRef<ILayer>
- Reactive bounding-box of the main content area after all items have claimed their space.
- mainStylesrequisRef<CSSProperties>
- Computed CSS properties applied to the main content slot (padding offsets derived from registered items).
- getLayoutItemrequis(id: string) => ILayerItem | undefined
- Retrieves the ILayerItem record for the given item id.
- itemsrequisRef<Array<ILayerItem>>
- Reactive list of all currently registered layout items.
- layoutRectrequisRef<DOMRectReadOnly | undefined>
- DOMRect of the layout root element, updated by a ResizeObserver.
- rootZIndexrequisRef<number>
- Base z-index from which layout item z-indices are calculated.
- layoutIdrequisComputedRef<string>
- Unique id of the layout instance, used to scope CSS properties.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Injecting the layout context in a custom layout item