components/monogram
Type Aliases
Section titled “Type Aliases”MonogramTone
Section titled “MonogramTone”MonogramTone =
"primary"|"secondary"|"accent"|"info"|"success"|"warning"
Theme tones a Monogram may take; the current Stipe theme supplies each color.
MonogramSize
Section titled “MonogramSize”MonogramSize =
"default"|"lg"|"xl"
Monogram scales: default sits inline with text; larger sizes stand alone as an
identity mark.
MonogramSubject
Section titled “MonogramSubject”MonogramSubject =
"actor"|"app"
Who the Monogram marks: people and Agents get a disc, Apps a rounded tile.
MonogramProps
Section titled “MonogramProps”MonogramProps =
object&Omit<HTMLAttributes<HTMLSpanElement>>,"children">>
Props accepted by Monogram.
Type Declaration
Section titled “Type Declaration”name:
string
The name whose first letter is shown.
optionalseed?:string
Stable identity that picks the tone; defaults to the name.
optionalsize?:MonogramSize
subject?
Section titled “subject?”
optionalsubject?:MonogramSubject
variant?
Section titled “variant?”
optionalvariant?:"initial"|"specimen"
Variables
Section titled “Variables”Monogram
Section titled “Monogram”
constMonogram:ForwardRefExoticComponent<object&Omit<HTMLAttributes<HTMLSpanElement>>,"children"> > &RefAttributes<HTMLSpanElement>>>>
A small decorative identity mark: the name’s first letter on a quiet tinted disc. The enclosing control owns the accessible name.
Functions
Section titled “Functions”monogramTone()
Section titled “monogramTone()”monogramTone(
seed):MonogramTone
A stable tone for an identity: the same seed always gets the same tone.
Parameters
Section titled “Parameters”string