Vitepress Theme Akari Docsv1.0.0GitHubSettingsMore

Navigation: API ​

The content below comes from the component metadata of @m3e/web 2.10.3.

m3e-nav-menu and m3e-nav-menu-item ​

m3e-nav-menu has no attributes. Its default slot holds m3e-nav-menu-item elements.

AttributeValuesDefaultDescription
openBooleanfalseExpands the child items
selectedBooleanfalseThe current item; the component maps it to aria-current
disabledBooleanfalseDisables this item and all its children
SlotContent
(default)Nested child items
labelText, usually a link
iconIcon
selected-iconIcon when selected
badgeBadge
toggle-iconExpand and collapse icon
EventWhen
opening, opened, closing, closedExpanding and collapsing start and finish
clickOn click

m3e-tabs, m3e-tab and m3e-tab-panel ​

m3e-tabs attributeValuesDefaultDescription
variantprimary, secondarysecondaryAppearance
stretchBooleanfalseTabs get equal widths and fill the container
header-positionbefore, afterbeforeWhether the tab bar comes before or after the panels
disable-paginationBooleanfalseHides the pagination buttons when tabs overflow
disable-swipeBooleanfalseTurns off swiping on a panel to switch tabs
previous-page-label, next-page-labelString"Previous page", "Next page"Accessible names of the pagination buttons
m3e-tab attributeValuesDefaultDescription
forPanel idNoneThe matching m3e-tab-panel
selectedBooleanfalseThe current tab; only one is allowed
disabledBooleanfalseDisabled

Write m3e-tab and m3e-tab-panel directly inside m3e-tabs, as in the example in Overview. The prev-icon and next-icon slots replace the pagination icons. Switching tabs fires beforeinput (can be canceled), input and change. m3e-tab also has an icon slot.

m3e-chip and m3e-filter-chip ​

AttributeUsed byValuesDefaultDescription
variantBothoutlined, elevatedoutlinedAppearance
valueBothStringNoneValue
selectedFilterBooleanfalseSelected
disabled, disabled-interactiveFilterBooleanfalseDisabled

Both have a default slot (text) plus icon and trailing-icon slots. m3e-chip is not interactive. m3e-filter-chip fires beforeinput, input and change when it toggles.

m3e-filter-chip-set wraps a group of filter chips: multi allows several selections, vertical stacks them vertically, hide-selection-indicator hides the selection mark, disabled disables the whole group, and name is for forms. It fires change when the selection changes.

m3e-badge ​

AttributeValuesDefaultDescription
sizesmall, medium, largemediumSize
forElement idNoneAnchors the badge to this element
positionabove-after, above-before, below-before, below-after, before, after, above, belowabove-afterPosition relative to the element when anchored

A badge has no default ARIA role. When you attach one to an interactive element, describe the count with aria-describedby or with matching visible text.

The theme's m3e.ts registers the components (@m3e/web/nav-menu, @m3e/web/tabs, @m3e/web/chips, @m3e/web/badge).

GitHub Settings

Search the docs

Type a page title, a component name or words from the text.

Press ⌘/Ctrl + K to open it anytime

Choose a language

EnglishEnglish (United States)العربيةArabic (Saudi Arabia)FrançaisFrench (France)日本語Japanese (Japan)한국어Korean (South Korea)简体中文Chinese (China)

Settings

Color
VariantTonal SpotVibrantFidelityExpressiveMonochromeNeutralRainbowFruit Salad
ContrastDefaultMediumHigh
MotionStandardExpressive
Text directionFollow languageLeft to rightRight to left
Text size100%150%200%