Skip to content

Navs

Pivot

Bit.BlazorUITabTabPage

The Pivot switches between two or more distinct sections of content from a single row (or column) of headers, where selecting a header shows the section it belongs to. Headers can carry an icon, a count and a dismiss button, be added to and dragged into a new order, run along any of the four sides, and fold into an overflow menu, a scroll area, a pair of slide buttons or extra lines when there is no room for all of them. The selection is a key you can bind, a change can be called off before it happens, and the whole header is a single tab stop that the arrow, Home and End keys navigate, as the WAI-ARIA tabs pattern describes.

Usage

Every example is live. Open its code to see exactly what produced the component running underneath.

Basic

A pivot is a list of BitPivotItems, each one a header and the content it shows. The first item that can be selected takes the selection to begin with, and selecting a header swaps the content underneath it. The whole header is a single tab stop: once it holds the focus, the arrow keys move between the tabs and Home and End jump to either end.

Pivot #1: File

Everything that has been saved to this workspace, newest first.

Icon and Count

A header can carry an icon before its text through IconName, and a number in parentheses after it through ItemCount, which is the usual way of telling how much a section holds without opening it. Both are optional and can be used on their own.

Pivot #1: Files

Everything that has been saved to this workspace, newest first.

HeaderType

The HeaderType picks the shape of the headers: Link (the default) marks the selected one with an animated indicator under it, while Tab fills the selected one with the color of the pivot. Link suits a page of content, Tab suits a denser panel where the selection has to survive a quick glance.

Link (default):

Pivot #1: File


Tab:

Pivot #1: File

Stacked

Stacked puts the icon of each header above its text instead of beside it, which is what makes a row of tabs fit a narrow screen without cutting the labels. It only changes the layout of the headers, so everything else on the pivot keeps working as it does.

Pivot #1: Home

FullWidth

FullWidth shares the whole width of the header between the items instead of leaving them huddled at one edge, which turns a handful of tabs into a segmented control. In a vertical pivot it shares the height in the same way, and Gap is what leaves room between the stretched items when they should read as separate rather than joined.

Pivot #1: Overview


Pivot #1: Overview

Alignment

The Alignment decides where the headers sit along the header line when they do not fill it, taking any value of the BitAlignment enum. Use FullWidth instead when the headers should share the whole line rather than be pushed to one side of it.

Start (default):

Pivot #1: File


Center:

Pivot #1: File


End:

Pivot #1: File


SpaceBetween:

Pivot #1: File

Position

The Position moves the header to any of the four sides of the content: Top (the default), Bottom, Start and End. Start and End lay the headers out in a column and turn the selection indicator on its side, and the tablist reports itself as vertical so that the up and down arrows are what navigate it.

Pivot Position: Top

Pivot #1: File

Everything that has been saved to this workspace, newest first.


Pivot Position: Bottom

Pivot #1: File

Everything that has been saved to this workspace, newest first.


Pivot Position: Start

Pivot #1: File

Everything that has been saved to this workspace, newest first.


Pivot Position: End

Pivot #1: File

Everything that has been saved to this workspace, newest first.

Overflow

The OverflowBehavior decides what happens when the headers no longer fit: Menu folds the ones that do not fit into a menu behind a More button, Slide adds a pair of buttons that scroll the header along, Scroll leaves a scroll bar under (or beside) it, Wrap runs them onto as many extra lines as they need, and None (the default) simply lets them overflow. Selecting a tab from the keyboard or from the bound key brings it back into view in the Scroll and Slide behaviors, including the tab the pivot starts on. The Slide header hides its scroll bar, so the mouse wheel over it moves it along instead of scrolling the page past it, and the page gets the wheel back at either end. The More button of the Menu behavior answers to the keys of a menu - the arrows step through it, Home and End jump to either end, Enter selects and Escape closes it, and Escape or a click away hands the focus back to the button - and it marks itself as the selected one while it is the selected tab that is folded away.

Menu (overflown tabs are moved into an overflow menu):

Content of the File tab.


Slide (next and previous buttons slide through the tabs):

Content of the File tab.


Scroll (a scroll bar is shown below the tabs):

Content of the File tab.


Wrap (the tabs that do not fit run onto the next line):

Content of the File tab.


AutoHideSlideButtons takes the slide buttons away entirely while the whole header fits, instead of leaving them in place in their disabled state:

Content of the File tab.


The overflow behavior also works with a vertical header (Position set to Start or End). A constrained height is required for the header to overflow vertically.

Menu (vertical):

Content of the File tab.


Slide (vertical):

Content of the File tab.


Scroll (vertical):

Content of the File tab.

Header content

HeaderStart and HeaderEnd put content of your own at either end of the header line, beside the tabs but outside the tablist, which is where the actions belonging to the whole pivot go. They keep their own place in the tab order, so the arrow keys still walk only the tabs.

Pivot #1: File

Dismissible

Dismissible adds a dismiss button to every header (a single item overrides it through its own Dismissible), and the Delete key does the same from the keyboard. The pivot never removes an item on its own, because the items belong to the markup that declares them, so OnItemDismiss is what takes it out of the list. When the tab being removed is the selected one, the selection moves to its neighbour by itself, and so does the focus. DismissIconName, DismissTitle and DismissAriaLabelFormat are what the button is drawn and named with.

Content of the Home tab.




A single item opting out of the dismiss button of the pivot:

Pivot #1: Home

Keyboard

The header is one tab stop and the arrow keys move the focus inside it, wrapping around at both ends; Home and End jump to the first and last tab, Enter and Space select the focused one, and a vertical pivot swaps the horizontal arrows for the vertical ones (in a right-to-left pivot the horizontal arrows are mirrored). Disabled and hidden tabs are stepped over. Delete dismisses the focused tab of a Dismissible pivot and Ctrl with an arrow key moves it in a Reorderable one, so the header can be worked through without ever leaving the keyboard.

SelectOnFocus makes the selection follow the focus, so a tab is selected the moment the arrow keys reach it - the automatic activation of the WAI-ARIA tabs pattern, which suits sections that are cheap to show:

Pivot #1: File



Navigable turned off gives every tab its own place in the tab order and takes the arrow keys out of the picture, for the rare case where the tabs are really a row of links:

Pivot #1: File



Loop turned off stops the navigation at both ends of the header instead of wrapping it around, so the last tab is really the last one the arrow keys reach:

Pivot #1: File

Binding

Give each item a Key and the selection becomes a value you own: @bind-SelectedKey follows the selection in both directions, while DefaultSelectedKey only picks the tab to start on and then leaves it alone. A key whose item is disabled or hidden is refused and the bound value goes back to the tab that is actually selected; a key nobody answers to is given until the end of the render to be answered, so adding a tab and selecting it can be one gesture. The pivot also hands over its SelectedItem and its Items, and takes a selection through SelectItemByKey, for the code that drives it from the outside.

Pivot #1: Samples



Selected key: 1

Detached

HeaderOnly renders the header without the panel underneath it, so the pivot becomes a selector for content that lives somewhere else on the page entirely - a detail pane, a section further up, or anything the selected key drives.

Hello I am Fooooooooooooo



Events

OnChange reports every change of the selection, wherever it came from - a click, the keyboard, the overflow menu or the bound key - while OnItemClick only fires for a header the user actually activated, even when that header was already the selected one. An item can also carry its own OnClick, and a Title that becomes the tooltip of its header.

Pivot #1: Foo


Last changed to:
Last header clicked:
Clicks on the Biz header: 0



OnChanging is asked just before the selection moves and calls the change off by setting the Cancel of its arguments, which is what a tab holding unsaved work, or one that is not ready to be shown, needs in order to refuse the selection. A change that is called off never reaches OnChange, and a bound key that was already moved goes back to the tab that is really selected:


Pivot #1: Draft

Last refused:

Templates

Header replaces the text of a header with markup of your own, and Body is the named alias of the content of the item, which is what lets the two be told apart once a header template is in play. An item count still follows a custom header, and an icon still comes before it.

Pivot #1

The content of the first item, given through the Body template.

Disabled

IsEnabled turns off the whole pivot, or a single item when it is set on the item itself. A disabled tab reports itself as such to assistive technologies, cannot be selected by a key that points at it, and is stepped over by the arrow keys.

Disabled pivot:

Pivot #1: File



Disabled pivot item:

Pivot #1: File



Disabled tab:

Pivot #1: File



Disabled tab item:

Pivot #1: File

Reorderable

Reorderable lets the headers be dragged onto one another, and the focused one be moved with Ctrl and an arrow key, so a header can be put in the order its user works in. Like the dismiss button, the pivot only asks: the items belong to the markup that declares them, so OnItemReorder hands over the item together with the index it is leaving and the index it is going to, and the handler is what moves it. A single item pins itself in place with its own Reorderable set to false.

Content of the File tab.

Mounting

By default only the selected tab is rendered, and leaving a tab throws its content away. KeepMounted keeps every tab that has been shown at least once around and hides it instead, so coming back to it finds the scroll position, the form and the state it was left in; a tab that has never been selected still costs nothing. MountAll goes further and renders every tab up front, which is what a page that has to read or export the content of the tabs it is not showing needs.

Type into the boxes, switch tabs and come back:

Default (the content of a tab that is left is thrown away):




KeepMounted (the content of a tab that has been shown is kept):




MountAll (every tab is rendered up front):

Addable

Addable puts a button after the last header that reports a request for a new tab through OnAdd. Like the dismiss button, the pivot only asks: the items belong to the markup that declares them, so the handler is what puts the new tab into the list and, through the bound key, what decides whether the pivot moves to it. The button sits beside the tablist rather than inside it, so the arrow keys still walk only the tabs, and AddIconName, AddTitle and AddAriaLabel are what it is drawn and named with.

Content of the Tab 1 tab.

Selected key: Tab 1

Gap

Gap sets the room left between the headers, taking any CSS length, which is what turns an airy row of tabs into a compact switch or the other way around. A vertical pivot spaces its column of headers with the same value.

Default:

Pivot #1: File


Gap: 0

Pivot #1: File


Gap: 2rem

Pivot #1: File

Color

Offering a range of specialized colors, providing visual cues for specific states within your application.
Using the Color parameter and its value of type BitColor enum:

Primary:

Pivot #1: File


Secondary:

Pivot #1: File


Tertiary:

Pivot #1: File


Info:

Pivot #1: File


Success:

Pivot #1: File


Warning:

Pivot #1: File


SevereWarning:

Pivot #1: File


Error:

Pivot #1: File


PrimaryBackground:

Pivot #1: File


SecondaryBackground:

Pivot #1: File


TertiaryBackground:

Pivot #1: File


PrimaryForeground:

Pivot #1: File


SecondaryForeground:

Pivot #1: File


TertiaryForeground:

Pivot #1: File


PrimaryBorder:

Pivot #1: File


SecondaryBorder:

Pivot #1: File


TertiaryBorder:

Pivot #1: File


Tab - Primary:

Pivot #1: File


Tab - Success:

Pivot #1: File


Tab - Error:

Pivot #1: File

External Icons

Use icons from external libraries like FontAwesome, and Bootstrap Icons with the Icon parameter.
See the BitIconInfo section in the parameters table for usage.


FontAwesome:

Pivot #1: Home

Once upon a time, stories wove connections between people, a symphony of voices crafting shared dreams. Each word carried meaning, each pause brought understanding. Placeholder text reminds us of that moment when possibilities are limitless, waiting for content to emerge.




Bootstrap:

Pivot #1: Home

Once upon a time, stories wove connections between people, a symphony of voices crafting shared dreams. Each word carried meaning, each pause brought understanding. Placeholder text reminds us of that moment when possibilities are limitless, waiting for content to emerge.

Size

The Size moves the headers along the type ramp - Small, Medium (the default) and Large - so a pivot can be the heading of a page or a quiet switch inside a panel without any styling of its own.

Small:

Pivot #1: File


Medium (default):

Pivot #1: File


Large:

Pivot #1: File

Style & Class

Style and Class reach the root element of the pivot, while Styles and Classes reach every part of it by name - the header and its container, a header item and the selected one, the icon, the text, the count, the dismiss and add buttons, the overflow menu and its items, and the body of the panel. See the BitPivotClassStyles section of the parameters table for the full list.

Component's Style & Class:

Pivot #1: File


Pivot #1: File



Styles & Classes:

Pivot #1: File



Pivot #1: File

RTL

Setting Dir to Rtl mirrors the pivot: the headers run from the right, the selection indicator and the slide buttons follow, the Start and End positions swap sides, and the left and right arrow keys are mirrored along with them.

لورم ایپسوم متن ساختگی با تولید سادگی نامفهوم از صنعت چاپ و با استفاده از طراحان گرافیک است.



لورم ایپسوم متن ساختگی با تولید سادگی نامفهوم از صنعت چاپ و با استفاده از طراحان گرافیک است.



لورم ایپسوم متن ساختگی با تولید سادگی نامفهوم از صنعت چاپ و با استفاده از طراحان گرافیک است.

API

Every parameter, public member, sub-class and enum this component exposes.

BitPivot parameters

Name Type Default value Description
Addable bool false Renders a button at the end of the pivot items that reports a request for a new tab through the OnAdd callback. The pivot does not add an item itself, since the items belong to the markup that declares them, so the handler is what puts the new one into the list.
AddAriaLabel string? null The aria-label of the add button of the pivot (default: Add).
AddIcon BitIconInfo? null Gets or sets the icon of the add button of the pivot using custom CSS classes for external icon libraries. Takes precedence over AddIconName when both are set.
AddIconName string? null Gets or sets the name of the icon of the add button of the pivot from the built-in Fluent UI icons (default: Add).
AddTitle string? null The title (tooltip) of the add button of the pivot (default: Add).
Alignment BitAlignment? null Determines the alignment of the header section of the pivot.
AriaLabelledBy string? null The id of the element that labels the header of the pivot (rendered into the aria-labelledby of the tablist), which is what names a pivot sitting under a heading of its own. It wins over the AriaLabel.
AutoHideSlideButtons bool false Renders the next and previous buttons of the Slide overflow behavior only while there actually is something to slide to, instead of leaving them in place in their disabled state.
ChildContent RenderFragment? null The content of pivot.
Classes BitPivotClassStyles? null Custom CSS classes for different parts of the pivot.
Color BitColor? null The general color of the pivot.
DefaultSelectedKey string? null Default selected key for the pivot.
DismissAriaLabelFormat string? null The format of the aria-label of the dismiss button of the pivot items (default: "Remove {0}"), where the placeholder is filled with the header text of the item.
DismissIcon BitIconInfo? null Gets or sets the icon of the dismiss button of the pivot items using custom CSS classes for external icon libraries. Takes precedence over DismissIconName when both are set.
DismissIconName string? null Gets or sets the name of the icon of the dismiss button of the pivot items from the built-in Fluent UI icons (default: Cancel).
Dismissible bool false Renders a dismiss button on every pivot item, which reports the item to dismiss through the OnItemDismiss callback. A single item opts in or out of it on its own using the Dismissible parameter of the BitPivotItem.
DismissTitle string? null The title (tooltip) of the dismiss button of the pivot items (default: Remove).
FullWidth bool false Stretches the pivot items to share the whole width (or the whole height in a vertical pivot) of the header.
Gap string? null The gap between the pivot items of the header.
HeaderEnd RenderFragment? null The content rendered at the end of the header, after the pivot items and after the overflow or slide affordances, which is where the actions belonging to the whole pivot usually go.
HeaderOnly bool false Whether to skip rendering the tabpanel with the content of the selected tab.
HeaderStart RenderFragment? null The content rendered at the start of the header, before the pivot items and before the overflow or slide affordances.
HeaderType BitPivotHeaderType BitPivotHeaderType.Link The type of the pivot header items.
KeepMounted bool false Keeps the content of every tab that has been shown at least once mounted, so that leaving a tab and coming back to it finds the content in the state it was left in. Unlike MountAll, a tab that has never been selected is not rendered at all.
Loop bool true Wraps the keyboard navigation of the header around at both of its ends, so that the next key on the last item lands on the first one.
MountAll bool false Mounts all tabs at render time and hide non-selected tabs with CSS styles instead of not-rendering them (useful for processing/extracting data).
Navigable bool true Enables the roving tabindex behavior, which turns the whole header into a single tab stop that is navigable using the arrow, Home, and End keys.
NextAriaLabel string? null The aria-label of the next button in the Slide overflow behavior (default: Next).
NextIcon BitIconInfo? null Gets or sets the icon of the next button in the Slide overflow behavior using custom CSS classes for external icon libraries. Takes precedence over NextIconName when both are set.
NextIconName string? null Gets or sets the name of the icon of the next button in the Slide overflow behavior from the built-in Fluent UI icons (default: ChevronRight for horizontal pivots and ChevronDown for vertical pivots).
OnAdd EventCallback Callback for when the add button of an Addable pivot is clicked.
OnChange EventCallback<BitPivotItem> Callback for when the selected pivot item changes.
OnChanging EventCallback<BitPivotChangeArgs> Callback for just before the selected pivot item changes, which can call the change off by setting the Cancel of its arguments, so that a tab holding unsaved work can refuse to be left.
OnItemClick EventCallback<BitPivotItem> Callback for when a pivot header item is clicked.
OnItemDismiss EventCallback<BitPivotItem> Callback for when the dismiss button of a pivot item is clicked, or the Delete key is pressed while it holds the focus. The pivot does not remove the item itself, since the items belong to the markup that declares them, so the handler is what takes the item out of the list.
OnItemReorder EventCallback<BitPivotReorderEventArgs> Callback for when a pivot item is dragged onto another one, or moved with the Ctrl+Arrow keys, in a Reorderable pivot. The pivot does not move the item itself, since the items belong to the markup that declares them, so the handler is what reorders the list.
OverflowAriaLabel string? null The aria-label of the overflow menu button in the Menu overflow behavior.
OverflowBehavior BitPivotOverflowBehavior? null Overflow behavior when there is not enough room to display all of the links/tabs.
OverflowIcon BitIconInfo? null Gets or sets the icon of the overflow menu button in the Menu overflow behavior using custom CSS classes for external icon libraries. Takes precedence over OverflowIconName when both are set.
OverflowIconName string? null Gets or sets the name of the icon of the overflow menu button in the Menu overflow behavior from the built-in Fluent UI icons (default: More).
Position BitPivotPosition BitPivotPosition.Top Position of the pivot header.
PreviousAriaLabel string? null The aria-label of the previous button in the Slide overflow behavior (default: Previous).
PreviousIcon BitIconInfo? null Gets or sets the icon of the previous button in the Slide overflow behavior using custom CSS classes for external icon libraries. Takes precedence over PreviousIconName when both are set.
PreviousIconName string? null Gets or sets the name of the icon of the previous button in the Slide overflow behavior from the built-in Fluent UI icons (default: ChevronLeft for horizontal pivots and ChevronUp for vertical pivots).
Reorderable bool false Lets the pivot items be dragged onto one another, and the focused one be moved with the Ctrl+Arrow keys, to ask for a new order through the OnItemReorder callback. A single item opts in or out of it on its own using the Reorderable parameter of the BitPivotItem.
SelectedKey string? null Key of the selected pivot item.
SelectOnFocus bool false Selects the focused pivot item while the header is navigated with the keyboard, so that the selection follows the focus (the automatic activation of the WAI-ARIA tabs pattern).
Size BitSize? null The size of the pivot header items.
Stacked bool false Stacks the icon of the pivot items on top of their text instead of putting the two side by side.
Styles BitPivotClassStyles? null Custom CSS styles for different parts of the pivot.

BitPivot public members

Name Type Default value Description
SelectedItem BitPivotItem? null The pivot item that is currently selected.
Items IReadOnlyList<BitPivotItem> The pivot items in the order they are declared in.
SelectItemByKey Task SelectItemByKey(string? key) Selects the pivot item carrying the given key, if such an item exists and is enabled.

BitComponentBase parameters

Name Type Default value Description
AriaLabel string? null Gets or sets the accessible label for the component, used by assistive technologies.
Class string? null Gets or sets the CSS class name(s) to apply to the rendered element.
Dir BitDir? null Gets or sets the text directionality for the component's content.
ForceAnimation bool false Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters.
Id string? null Gets or sets the unique identifier for the component's root element.
IsEnabled bool true Gets or sets a value indicating whether the component is enabled and can respond to user interaction.
Style string? null Gets or sets the CSS style string to apply to the rendered element.
TabIndex string? null Gets or sets the tab order index for the component when navigating with the keyboard.
Visibility BitVisibility BitVisibility.Visible Gets or sets the visibility state (visible, hidden, or collapsed) of the component.

BitComponentBase public members

Name Type Default value Description
UniqueId Guid Guid.NewGuid() Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed.
RootElement ElementReference Gets the reference to the root HTML element associated with this component.

BitPivotItem properties

Name Type Default value Description
Body RenderFragment? null The content of the pivot item, It can be Any custom tag or a text (alias of ChildContent).
BodyClass string? null The custom css class of the content of the pivot item.
BodyStyle string? null The custom css style of the content of the pivot item.
ChildContent RenderFragment? null The content of the pivot item, It can be Any custom tag or a text.
Dismissible bool? null Overrides the Dismissible of the parent pivot for this item alone, so a single tab can gain or lose its dismiss button independently of the rest.
Header RenderFragment? null The content of the pivot item header, It can be Any custom tag or a text.
HeaderText string? null The text of the pivot item header, The text displayed of each pivot link.
Icon BitIconInfo? null Gets or sets the icon to display next to the pivot link using custom CSS classes for external icon libraries. Takes precedence over IconName when both are set.
IconName string? null Gets or sets the name of the icon to display next to the pivot link from the built-in Fluent UI icons.
ItemCount int? null Defines an optional item count displayed in parentheses just after the link text.
IsSelected bool false Whether or not the item is selected. An item that declares itself selected takes the selection of the pivot when it is registered.
Key string? null A required key to uniquely identify a pivot item.
OnClick EventCallback Callback for when this pivot item header is clicked or activated from the keyboard.
OnDismiss EventCallback Callback for when the dismiss button of this pivot item is clicked, or the Delete key is pressed while it holds the focus.
Reorderable bool? null Overrides the Reorderable of the parent pivot for this item alone, so a single tab can be pinned in place while the rest of the header is reordered, or the other way around.
Title string? null The title (tooltip) of the pivot item header, which is the usual place for the full text of a header that is too long to be shown in one.

BitPivotChangeArgs properties

Name Type Default value Description
Item BitPivotItem The pivot item the selection is about to move to.
Cancel bool false Set to true to cancel the change and keep the item that is currently selected.

BitPivotReorderEventArgs properties

Name Type Default value Description
Item BitPivotItem The pivot item that is being moved.
OldIndex int 0 The index the item is moving from.
NewIndex int 0 The index the item is moving to.

BitPivotClassStyles properties

Name Type Default value Description
Root string? null Custom CSS classes/styles for the root element of the BitPivot.
Header string? null Custom CSS classes/styles for the header of the BitPivot.
HeaderContainer string? null Custom CSS classes/styles for the header container (wrapper) of the BitPivot.
SlideButton string? null Custom CSS classes/styles for the slide (next/previous) buttons of the BitPivot in the Slide overflow behavior.
OverflowButton string? null Custom CSS classes/styles for the overflow menu button of the BitPivot in the Menu overflow behavior.
OverflowCallout string? null Custom CSS classes/styles for the overflow menu (callout) of the BitPivot in the Menu overflow behavior.
OverflowItem string? null Custom CSS classes/styles for the overflow menu item of the BitPivot in the Menu overflow behavior.
Body string? null Custom CSS classes/styles for the items body of the BitPivot.
HeaderItem string? null Custom CSS classes/styles for the header item of the BitPivot.
SelectedItem string? null Custom CSS classes/styles for the selected item of the BitPivot.
HeaderItemContent string? null Custom CSS classes/styles for the header item content of the BitPivot.
HeaderIconContainer string? null Custom CSS classes/styles for the header icon container of the BitPivot.
HeaderIcon string? null Custom CSS classes/styles for the header icon of the BitPivot.
HeaderText string? null Custom CSS classes/styles for the header text of the BitPivot.
HeaderItemCount string? null Custom CSS classes/styles for the header item count of the BitPivot.
HeaderStart string? null Custom CSS classes/styles for the start content of the header of the BitPivot.
HeaderEnd string? null Custom CSS classes/styles for the end content of the header of the BitPivot.
DismissButton string? null Custom CSS classes/styles for the dismiss button of the header items of the BitPivot.
DismissIcon string? null Custom CSS classes/styles for the dismiss icon of the header items of the BitPivot.
AddButton string? null Custom CSS classes/styles for the add button of the BitPivot.
AddIcon string? null Custom CSS classes/styles for the add icon of the BitPivot.

BitIconInfo properties

Name Type Default value Description
Name string? null Gets or sets the name of the icon.
BaseClass string? null Gets or sets the base CSS class for the icon. For built-in Fluent UI icons, this defaults to "bit-icon". For external icon libraries like FontAwesome, you might set this to "fa" or leave empty.
Prefix string? null Gets or sets the CSS class prefix used before the icon name. For built-in Fluent UI icons, this defaults to "bit-icon--". For external icon libraries, you might set this to "fa-" or leave empty.

BitAlignment enum

Name Value Description
Start 0
End 1
Center 2
SpaceBetween 3
SpaceAround 4
SpaceEvenly 5
Baseline 6
Stretch 7

BitPivotHeaderType enum

Name Value Description
Tab 0 Renders pivot header items as Tab.
Link 1 Renders pivot header items as link.

BitSize enum

Name Value Description
Small 0 The small size.
Medium 1 The medium size.
Large 2 The large size.

BitPivotOverflowBehavior enum

Name Value Description
None 0 Pivot links will overflow the container and may not be visible.
Menu 1 Display an overflow menu that contains the tabs that don't fit.
Scroll 2 Display a scroll bar below of the tabs for moving between them.
Slide 3 Display next and previous buttons to slide through the tabs that don't fit.
Wrap 4 Wrap the tabs that don't fit onto as many extra lines (or columns) as they need.

BitPivotPosition enum

Name Value Description
Top 0 Display header at the top.
Bottom 1 Display header at the Bottom.
Start 2 Display header at the start (Left for LTR and Right for RTL).
End 3 Display header at the end (Right for LTR and Left for RTL).

BitColor enum

Name Value Description
Primary 0 Primary general color.
Secondary 1 Secondary general color.
Tertiary 2 Tertiary general color.
Info 3 Info general color.
Success 4 Success general color.
Warning 5 Warning general color.
SevereWarning 6 SevereWarning general color.
Error 7 Error general color.
PrimaryBackground 8 Primary background color.
SecondaryBackground 9 Secondary background color.
TertiaryBackground 10 Tertiary background color.
PrimaryForeground 11 Primary foreground color.
SecondaryForeground 12 Secondary foreground color.
TertiaryForeground 13 Tertiary foreground color.
PrimaryBorder 14 Primary border color.
SecondaryBorder 15 Secondary border color.
TertiaryBorder 16 Tertiary border color.

BitVisibility enum

Name Value Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).

BitDir enum

Name Value Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.

Feedback

Found a mistake, a gap, or something that could be clearer? Every page and every component is one click from its source.