c2n/web-componentsv0.0.6
GitHub repository

Side Nav

Responsive navigation drawer beside the page: pushes the content on large screens, slides over it with a backdrop on small ones.

Attributes

NameTypeDefaultDescription
openedbooleanfalseWhether the drawer is open. On phones (and on tablets unless `tablet-mode` is set explicitly) the initial value is ignored and the drawer starts closed.
desktop-modeDisplayModesideHow the drawer behaves at 960px and up: `side` pushes the content, `over` slides above it.
tablet-modeDisplayModeoverHow the drawer behaves between 600px and 959px.
responsive-tabletbooleanfalseAlso collapse the drawer on tablets in `side` mode when the viewport shrinks to that size.
positionSideNavPositionstartWhich edge the drawer is on: `start` (left in LTR) or `end`.

Events

NameTypeDescription
opened-changeCustomEvent<OpenedChangeEventDetail>Fired when the user or a breakpoint change opens or closes the drawer (not when `opened` is set from code). `detail.opened` is the new state.

CSS custom properties

Grouped by the element and state they target. Click a group to collapse it; click a name to copy it.

NameTypeDefaultDescription
--c2-side-nav--transition-durationtime250ms
--c2-side-nav--background-colorcolor#fafafa
--c2-side-nav--colorcolor—
--c2-side-nav--border-top-left-radiusborder-radius—
--c2-side-nav--border-top-right-radiusborder-radius—
--c2-side-nav--border-bottom-left-radiusborder-radius—
--c2-side-nav--border-bottom-right-radiusborder-radius—
--c2-side-nav--padding-toppadding16px
--c2-side-nav--padding-rightpadding16px
--c2-side-nav--padding-bottompadding16px
--c2-side-nav--padding-leftpadding16px
--c2-side-nav--border-topborder—
--c2-side-nav--border-rightborder—
--c2-side-nav--border-bottomborder—
--c2-side-nav--border-leftborder—
--c2-side-nav__open--widthpixel240px
--c2-side-nav__close--widthpixel0pxWidth of the collapsed drawer; a non-zero value gives a rail.
--c2-side-nav__divider--widthpixel1pxLine between the drawer and the content, on whichever side the drawer is.
--c2-side-nav__divider--colorcolor#e4e4e7
--c2-side-nav__scrollbar--colorcolorrgba(0, 0, 0, 0.2)
--c2-side-nav__over--positionpositionfixed`absolute` keeps the overlay inside a positioned parent.
--c2-side-nav__over--toppixel0px
--c2-side-nav__over--heightpixel100dvh
--c2-side-nav__over--widthpixel—Defaults to the open width.
--c2-side-nav__over--background-colorcolor—Defaults to the drawer background.
--c2-side-nav__over--box-shadowbox-shadow0 12px 40px rgba(0, 0, 0, 0.18)
--c2-side-nav__over--border-top-left-radiusborder-radius—
--c2-side-nav__over--border-top-right-radiusborder-radius—
--c2-side-nav__over--border-bottom-left-radiusborder-radius—
--c2-side-nav__over--border-bottom-right-radiusborder-radius—
--c2-side-nav__over--padding-toppadding—
--c2-side-nav__over--padding-rightpadding—
--c2-side-nav__over--padding-bottompadding—
--c2-side-nav__over--padding-leftpadding—
--c2-side-nav__backdrop--background-colorcolorrgba(0, 0, 0, 0.32)
--c2-side-nav__backdrop--backdrop-filterfilternone
--c2-side-nav__backdrop--z-indexnumber1000
escAccordionConnected, animated panels with shared borders and single or multiple expansion.LayoutAvatarImage, initials or icon for a person, with status dot and badge.Data displayBadgeTinted pill for status text, counts and dots, optionally pinned to a corner of another element.Data displayBreadcrumbNavigation trail of link buttons with separators, a current page and optional collapsing.NavigationButtonThemeable button with slots for text, prefix, suffix and running icons.ButtonsButton GroupAttached buttons with shared borders, optionally a segmented control with single or multiple selection.ButtonsCardGroups related content and actions on a single bordered surface.LayoutChat InputAuto-growing message box with a send button for chat interfaces.ChatChat MessageOne chat bubble with avatar, title, timestamp and message body.ChatCheckboxNative checkbox behaviour in a quiet, themeable box with an opt-in hover layer.InputsCode ViewerSyntax-highlighted code with line numbers, copy button and dark mode, powered by shiki.Data displayColor AreaTwo-dimensional area for picking saturation and value of a colour.InputsColor SelectColour swatch that opens a full picker built from area and slider.InputsColor SliderHorizontal slider for choosing a hue from 0 to 360.InputsCopy ButtonButton that copies text to the clipboard — the element it sits in, another element by id, or a literal string.ButtonsDetailsCollapsible disclosure built on native details and summary.LayoutIcon ButtonRound, hoverable button wrapping a slotted SVG icon.ButtonsKbdKeyboard key label for shortcuts and command hints, with the semantics of the native kbd element.Data displayLabelCaption that names and activates the control referenced by its for attribute, with a required marker.InputsLink ButtonText-styled control for link and navigation actions, rendered as a real anchor or a button.NavigationListVertical list container with single or multiple selection.Data displayList ItemSelectable row with icon slots, used on its own or as the option of list and select.Data displayMenuCommands, links, checkboxes and submenus in a popover anchored to a trigger.NavigationModalDialog built on the native dialog element: focus trap, backdrop, Escape, title, body and footer.FeedbackNavigation MenuSite navigation bar whose triggers open panels of links below the header.NavigationOverlayAnchored popup built on the browser Popover API, positioned with floating-ui.FeedbackPaginationPage navigation in three layouts: numbered pages, a simple page status, or a table-footer row with rows-per-page.NavigationProgressLinear progress bar, indeterminate or filling to a value, with an optional label and count.FeedbackRadioRadio options built on native inputs, grouped into one value with keyboard navigation.InputsSelectDropdown that pairs a themeable trigger with an anchored list of c2-list-item options.InputsSeperatorHorizontal or vertical rule with an optional label, for dividing content and toolbars.LayoutSheetDialog pinned to an edge of the screen, for content that complements the page rather than interrupting it.FeedbackSide NavResponsive navigation drawer beside the page: pushes the content on large screens, slides over it with a backdrop on small ones.NavigationSkeletonPlaceholder block standing in for content that has not arrived, in three shapes and three animations.FeedbackSliderRange input with a themeable track, thumb, step ticks and value bubble.InputsSpinnerCircular progress indicator, indeterminate or showing a value, with optional text.FeedbackSwitchOn/off toggle on a native switch input, with label, description and thumb icons.InputsTableVirtualized data grid with declarative columns, sorting, selection, pinning and resizing.Data displayTabsTab strip that shows one content panel at a time.NavigationText FieldSingle-line input with icon slots, clear button, helper and error text, and a character counter.InputsTextareaMultiline text input with resizing, helper and error text, and a character counter.InputsToastNotification cards and a manager for stacked, queued notifications with independent lifetimes.FeedbackTooltipContextual hint shown when its target is hovered or focused, rendered in the top layer.FeedbackFeather Icons287 open-source Feather icons, one web component each.IconsMat Icon2,234 Material Icons ligatures rendered through a single element.IconsPhosphor Icons1,512 flexible icons in six weights, one web component each.IconsThemingTheme every c2n component from a handful of design tokens with @c2n/theme, or reach for any component variable directly.GuideUsing c2n in an applicationThe workflow behind every c2n app: load the theme once, use c2-* tags directly, and turn every repeated pattern into a small variant or composed component.Guide