@k8ordo/ui

SideNav

見出しごとにまとめたリンクのサイドナビです。今のページは傍線で示します。

インポート

ts
import { SideNav } from '@k8ordo/ui';

使い方

@k8ordo/uiはルーターを持たないので、どのリンクが今のページかはcurrentで渡します。そのリンクにはaria-current="page"が付き、傍線で示されます。

tsx
<SideNav.Root label="Guide">
  <SideNav.Group title="Getting started">
    <SideNav.Link current href="/get-started">
      Get started
    </SideNav.Link>
    <SideNav.Link href="/theming">Theming</SideNav.Link>
  </SideNav.Group>
  <SideNav.Group title="Components">
    <SideNav.Link href="/button">Button</SideNav.Link>
  </SideNav.Group>
</SideNav.Root>

ルーターのリンクへの差し替え

renderAnchorは、リンクの要素そのものを差し替えます。受け取るpropsにはhrefとclassName、children、aria-currentが入っています。ドロワーを閉じるonClickのように、渡した属性もすべて入っています。

tsx
<SideNav.Link
  current={matchPath(item.path, pathname) !== null}
  href={href(item.path)}
  onClick={closeDrawer}
  renderAnchor={({ children, ...props }) => (
    <Link {...props}>{children}</Link>
  )}
>
  {item.name}
</SideNav.Link>

Props

SideNav.Root

label
Type: string
Default: -
children?
Type: ReactNode
Default: -
PropTypeDefault
labelstring-
children?ReactNode-

継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLElement>

SideNav.Group

title
Type: string
Default: -
children?
Type: ReactNode
Default: -
PropTypeDefault
titlestring-
children?ReactNode-

SideNav.Link

children
Type: ReactNode
Default: -
href
Type: T
Default: -
current?
Type: boolean
Default: false
renderAnchor?
Type: (props: RenderSideNavAnchorProps<T>) => ReactNode
Default: defaultRenderAnchor
PropTypeDefault
childrenReactNode-
hrefT-
current?booleanfalse
renderAnchor?(props: RenderSideNavAnchorProps<T>) => ReactNodedefaultRenderAnchor

継承する属性(内部で固定するものを除く): AnchorHTMLAttributes<HTMLAnchorElement>

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。