Panel

<Panel> adds a tab to the dialog after Info and Technical, with its own label. Inside, write as on the other tabs: <H2> headings space it into sections. Use it for reading that is neither a rule nor SQL, such as worked examples. A table in it can be a <DefTable> from ~/components/report-kit/info.

Example

import { DefTable, H2, Info, P, Panel } from "~/components/report-kit/info"

// in defineReport({ … })
page: {
  info: () => (
    <>
      <Info>
        <P>Sales per region, including tax.</P>
      </Info>
      <Panel label="Examples">
        <H2>An order in two regions</H2>
        <DefTable
          term="Region"
          definition="Amount of order A-1001"
          rows={[
            { name: "North", def: "60" },
            { name: "South", def: "40" },
          ]}
        />
        <P>An order shipped to two regions counts in both.</P>
      </Panel>
    </>
  ),
},

Props

NameTypeRequiredDefaultMeaning
labeltextyesThe tab's name
childrencontentnoThe tab's content

Checks

A panel without label fails the typecheck. A panel outside page.info is not drawn.