Text#

The <Text> component renders a <span> with basic reset styles by default.

A text comes in two different forms:

Text.Block: Text rendered as block display.
Text: Text rendered as inline.

The inline Text component should only be rendered within a:

Import#

import { Text } from 'bumbag'

Usage#

Hello world! This is a bit of text.

Editable example

<Text.Block>
  Hello world! This is a bit of
  <Text fontWeight="bold">text</Text>.
</Text.Block>

<Text.Block>
  Hello world! This is a bit of
  <Text fontWeight="bold">text</Text>.
</Text.Block>

Other elements#

Bold
Italic
Underline
I18N
Citation
~~Deleted~~
Emphasis
Inserted
Ctrl + C
Highlighted
~~Strikethrough~~
Sample
_sub
^sup

Editable example

<Text use="strong">Bold</Text><br />
<Text use="i">Italic</Text><br />
<Text use="u">Underline</Text><br />
<Text use="abbr">I18N</Text><br />
<Text use="cite">Citation</Text><br />
<Text use="del">Deleted</Text><br />
<Text use="em">Emphasis</Text><br />
<Text use="ins">Inserted</Text><br />
<Text use="kbd">Ctrl + C</Text><br />
<Text use="mark">Highlighted</Text><br />
<Text use="s">Strikethrough</Text><br />
<Text use="samp">Sample</Text><br />
<Text use="sub">sub</Text><br />
<Text use="sup">sup</Text>

<Text use="strong">Bold</Text><br />
<Text use="i">Italic</Text><br />
<Text use="u">Underline</Text><br />
<Text use="abbr">I18N</Text><br />
<Text use="cite">Citation</Text><br />
<Text use="del">Deleted</Text><br />
<Text use="em">Emphasis</Text><br />
<Text use="ins">Inserted</Text><br />
<Text use="kbd">Ctrl + C</Text><br />
<Text use="mark">Highlighted</Text><br />
<Text use="s">Strikethrough</Text><br />
<Text use="samp">Sample</Text><br />
<Text use="sub">sub</Text><br />
<Text use="sup">sup</Text>

Text Props#

Inherits Box props

use

string
  | (ComponentClass<any, any> & { useProps: any; })
  | (FunctionComponent<any> & { useProps: any; })

className string

children

string
  | number
  | boolean
  | {}
  | ReactElement<any, string
  | ((props: any) => ReactElement<any, string
  | ...
  | (new (props: any) => Component<any, any, any>)>)
  | (new (props: any) => Component<...>)>
  | ReactNodeArray
  | ReactPortal
  | ((props: BoxProps) => ReactNode)

alignX "right" | "left" | "center"

alignY "top" | "bottom" | "center"

variant string

colorMode string

disabled boolean

overrides

{
  useCSSVariables?: boolean;
  altitudes?: AltitudesThemeConfig;
  borders?: BordersThemeConfig;
  borderRadii?: BorderRadiiThemeConfig;
  ... 95 more ...;
  Template?: TemplateThemeConfig;
}

elementRef ((instance: any) => void) | RefObject<any>

themeKey string

Theming#

Text.styles.base

Hello world

On this page