Skip to content

Note ​

Note is a remark without a line or a surface.

When to use ​

Use it for one sentence that adds to what is around it. A notice with a line is a Banner; the remark under an input is the note of its Field.

Props ​

PropDefaultDescription
tonewarn (yellow) or error (red); muted without it
iconAn icon before the text (a name or a component)
clampfalseOne line with an ellipsis
childrenrequiredThe text

Contract ​

It is text in the caption role, muted or in the color of its tone. An icon is gap-sm from the text and centred on the ink of the first line. In a layout the text keeps its line box; inside a control, such as a list item, it is trimmed to its ink. With clamp it is one line with an ellipsis, and the full text shows on hover and on keyboard focus.

Example ​

Note

Released under the Apache-2.0 license.