Code

The Code component is used to display inline code snippets and blocks of code.

Usage

Inline code

<Code>npm install @oztix/roadie-components</Code>

Examples

Emphasis

Different emphasis levels for various contexts:

<View gap='200' flexDirection='row' flexWrap='wrap'>
  <Code emphasis='default'>default code</Code>
  <Code emphasis='strong'>strong code</Code>
  <Code emphasis='subtle'>subtle code</Code>
  <Code emphasis='subtler'>subtler code</Code>
</View>

Color palettes

Neutral is the default color palette for code elements.

Each color palette is designed for specific use cases:

<View gap='200' flexDirection='row' flexWrap='wrap'>
  <Code colorPalette='neutral'>neutral</Code>
  <Code colorPalette='accent'>accent</Code>
  <Code colorPalette='brand'>brand</Code>
  <Code colorPalette='information'>information</Code>
  <Code colorPalette='success'>success</Code>
  <Code colorPalette='warning'>warning</Code>
  <Code colorPalette='danger'>danger</Code>
</View>

Props

CodeProps

emphasis?

ConditionalValue<"strong" | "default" | "subtle" | "subtler">

The appearance of the code block

Defaults to 'default'.

colorPalette?

"neutral" | "accent" | "brand" | "brandSecondary" | "success" | "warning" | "danger" | "information"

The color palette to use for the code

Defaults to 'neutral'.

children?

ReactNode

The content to display