Anatomy
Section Header

Section Header

Header for each Section.

The SectionHeader component serves as a <h2/> element, with the appropriate labels. The content within the SectionHeader is used to generate the corresponding Index Items.

If the header text is lengthy and a shorter title is desired for the Index Item, you can provide an alternative using the title prop.

Props

PropDescriptionRequired
titleoverrides the children to create the corresponding Index Itemfalse
classNameAdditional CSS classes for the componentfalse
styleInline CSS stylesfalse

Sample Usage

<Suchi.Root accentColor="orangered" className="article_wrapper my-8" style={{ padding: "16px"}}>
  <Suchi.Index />
  <Suchi.Header className="my-4 text-3xl font-bold">Building a NPM Libray</Suchi.Header>
 
  <Suchi.Section className="my-4">
    <Suchi.SectionHeader className="text-2xl">Project Setup</SectionHeader>
    <Suchi.Content>
      <Suchi.Reference/>
    </Suchi.Content>
  <Suchi.Section>
</Suchi.Root>