@s-ui/documentation-library

gh: [e-mail]:SUI-Components/docs-components

homepage: https://github.com/SUI-Components/docs-components/

Install

npm install @s-ui/documentation-library

Components

Anchor

HTML a element DOC styled

Article

HTML article element DOC styled

Avatar

Component used to represent people or objects DOC styled

Box

A Box can be used to display content related to a single subject DOC styled

Button

HTML button element DOC styled. Triggers an operation on click.

ButtonGroup

HTML wrapper to group multiple button HTML elements DOC styled.

Code

HTML code element DOC styled

BackgroundColorConsumer

Pantone card of the background element color

Pantone

Pantone card of the background element color

Grid

div element css-grid styled in order to allocate elements

Cell

div element css-grid styled in order to allocate elements in the grid disposed.

Heading

Create HTML tag titles.

H1

HTML h1 element DOC styled

H2

HTML h1 element DOC styled

H3

HTML h3 element DOC styled

H4

HTML h4 element DOC styled

AntDesignIcon

Ant-Design icon DOC styled

BootstrapIcon

Bootstrap icon DOC styled

BoxIcon

Box icon DOC styled

DevIcon

DevIcon DOC styled

FeatherIcon

Feather Icon DOC styled

FlatColorIcon

Flat Color Icon DOC styled

Input

HTML input element DOC styled

Label

The HTML label element represents a caption for an item in a user interface.

UnorderedList

The HTML ol element represents an ordered list of items — typically rendered as a numbered list.

OrderedList

The HTML ul element represents an unordered list of items, typically rendered as a bulleted list.

ListItem

The HTML li element is used to represent an item in a list.

Paragraph

The HTML p element represents a paragraph.

Quote

The HTML q element indicates that the enclosed text is a short inline quotation. Most modern browsers implement this by surrounding the text in quotation marks.

Radio

The <input type="radio"> defines a radio button. RadioButton buttons are normally presented in radio groups (a collection of radio buttons describing a set of related options). Only one radio button in a group can be selected at the same time.

RadioGroup

Radio options element wrapper

RadioButton

The <input type="radio"> defines a radio button styled like a button. RadioButton buttons are normally presented in radio groups (a collection of radio buttons describing a set of related options). Only one radio button in a group can be selected at the same time.

RadioButtonGroup

Radio button options element wrapper

Separator

The HTML hr element represents a thematic break between paragraph-level elements: for example, a change of scene in a story, or a shift of topic within a section.

Text

Simple plain text styled

Bold

The HTML Bring Attention To element (b) is used to draw the reader's attention to the element's contents, which are not otherwise granted special importance.

Strong

The HTML Strong Importance Element (strong) indicates that its contents have strong importance, seriousness, or urgency. Browsers typically render the contents in bold type.

Idiomatic

The HTML Idiomatic Text element (i) represents a range of text that is set off from the normal text for some reason, such as idiomatic text, technical terms, taxonomical designations, among others.

Emphasis

The HTML em element marks text that has stress emphasis. The <em> element can be nested, with each level of nesting indicating a greater degree of emphasis.

Mark

The HTML Mark Text element (mark) represents text which is marked or highlighted for reference or notation purposes, due to the marked passage's relevance or importance in the enclosing context.

Small

The HTML `small element represents side-comments and small print, like copyright and legal text, independent of its styled presentation. By default, it renders text within it one font-size smaller, such as from small to x-small

Deleted

The HTML del element represents a range of text that has been deleted from a document.

Inserted

The HTML ins element represents a range of text that has been added to a document.

Subscript

The HTML Subscript element (sub) specifies inline text which should be displayed as subscript for solely typographical reasons.

Superscript

The HTML Superscript element (sup) specifies inline text which is to be displayed as superscript for solely typographical reasons.