Krizaka
Documentation

Mascot quote

A rule, a promise or a decision told by a bird: the sentence in a speech bubble, the bird under its tail and who speaks — inline in a card, callout alone in a section.

WebBetaBlocks

Web only — React, from @krizaka/ui/mascot-quote. Beta: its API may still change in a minor version.

When to use

  • To state the rule a feature stands for (the falcon watches, the owl reads, the duck builds, the flamingo answers or gets paid, the pigeon delivers, the lovebird introduces).
  • A promise that deserves its own moment in a section (callout).

When not to use

  • For a bird that only decorates: a bird carries a promise, or it is not there.Use instead: Mascots
  • For a status or a warning the reader must act on.Use instead: Alert

Installation

Install

npm install @krizaka/ui @krizaka/tailwind @krizaka/tokens tailwindcss

Styles

@import "tailwindcss";
@import "@krizaka/tailwind";
@import "@krizaka/ui/tailwind.css";

Import

import { MascotQuote } from "@krizaka/ui/mascot-quote";

Examples

Inline

The falcon's rule, small, beside a paragraph or inside a card.

Nothing crosses the walls: no prompt, no file, no metric.

The falcon's rule

Callout

The owl's promise, alone in a section, the bird alive.

Every personal record stays in Québec, and you can read who touched it — Law 25, by design.

The owl's promise

Props

A sentence told by a bird: a speech bubble, the bird under its tail, who speaks. The bird is decorative.

PropTypeDefaultDescription
birdrequired"falcon" | "owl" | "duck" | "flamingo" | "pigeon" | "lovebird"—The bird that speaks — the one whose idea it is.
childrenrequiredReactNode—The sentence: the rule, the promise.
labelrequiredReactNode—Who speaks, under the bubble: The falcon's rule.
animatedboolean—The bird's idle loop (it pauses off screen and stops under reduced motion). Defaults to true for a callout.
mood"success" | "error" | "empty" | "welcome" | "thinking"thinkingIts mood.
variant"inline" | "callout"inlineinline inside a card (small, the bird answers the pointer); callout alone in a section (larger, the bird alive).

Accessibility

  • A figure with a blockquote and its figcaption: read as a quote and who says it.
  • The bird is decorative (aria-hidden); its idle loop pauses off screen and stops under prefers-reduced-motion.

Best practices

  • One bird per idea, the same bird for the same idea everywhere.
  • One sentence, said as a rule: short, in the present tense.
  • The label says who speaks (The falcon's rule): words as props.

Generated from the code of @krizaka/ui 2.8.0: its meta.ts, its examples and its types.Edit this documentation on GitHub

On this page