Skip to content

SeparatorProps.md

Latest commit

 

History

History
147 lines (78 loc) · 2.49 KB

SeparatorProps.md

File metadata and controls

147 lines (78 loc) · 2.49 KB
Raw

tinky

tinky / SeparatorProps

Interface: SeparatorProps

Props for the Separator component.

Extends

Properties

backgroundColor?

readonly optional backgroundColor?: LiteralUnion<ForegroundColorName, string>

Same as color, but for the background.

Inherited from

TextStyles.backgroundColor

bold?

readonly optional bold?: boolean

Make the text bold.

Inherited from

TextStyles.bold

char?

readonly optional char?: string

The character to repeat for the separator line.

Default Value

"─";

Example

<Separator char="=" />

color?

readonly optional color?: LiteralUnion<ForegroundColorName, string>

Change text color. Tinky uses Ansis under the hood, so all its functionality is supported.

Inherited from

TextStyles.color

dimColor?

readonly optional dimColor?: boolean

Dim the color (make it less bright).

Inherited from

TextStyles.dimColor

direction?

readonly optional direction?: "horizontal" | "vertical"

The direction of the separator.

  • "horizontal": The separator will expand horizontally to fill the container's width. Height will be 1 row.
  • "vertical": The separator will expand vertically to fill the container's height. Width will be 1 column.

Default Value

"horizontal";

inverse?

readonly optional inverse?: boolean

Inverse background and foreground colors.

Inherited from

TextStyles.inverse

italic?

readonly optional italic?: boolean

Make the text italic.

Inherited from

TextStyles.italic

strikethrough?

readonly optional strikethrough?: boolean

Make the text crossed out with a line.

Inherited from

TextStyles.strikethrough

underline?

readonly optional underline?: boolean

Make the text underlined.

Inherited from

TextStyles.underline