Skip to content
Binary UIKit reference Stable

AppShell

Responsive application shell with navigation, search, and mobile tabs.

Use AppShell for a localized application frame with primary navigation, search, content, and mobile navigation.

Interactive example

Loading interactive example

API

MemberTypeKindRequiredDefault
accountSnippetsnippetNoundefined
brandSnippetsnippetNoundefined
childrenSnippetsnippetNoundefined
contentIdstringpropNoundefined
drawerOpenbooleanbindingNofalse
fabAppShellFabpropNoundefined
headerSnippetsnippetNoundefined
heightnumber | stringpropNo'100dvh'
labelsAppShellLabelspropYes
mainLandmarkbooleanpropNotrue
navAppNavItem[]propNo[]
onSearchSelect(item: CommandPaletteItem) => voidcallbackNoundefined
onSearchSubmit(query: string) => voidcallbackNoundefined
searchbooleanpropNotrue
searchEmptySnippetsnippetNoundefined
searchFilterboolean | ((item: CommandPaletteItem, query: string) => boolean)callbackNoundefined
searchHotkeystring | falsepropNo'k'
searchHotkeyHintstringpropNoundefined
searchItemsCommandPaletteItem[] | CommandPaletteGroup[]propNo[]
searchLabelstringpropNo'Search'
searchOpenbooleanbindingNofalse
searchPlaceholderstringpropNo'Search…'
searchQuerystringbindingNo''
searchRowSnippet<[CommandPaletteItem, boolean]>snippetNoundefined
searchTrigger'topbar' | 'sidebar-top' | 'sidebar-bottom'propNo'topbar'
tabsAppNavItem[]propNoundefined

Examples

Source

Loading source