Atoms / Badge

Badge

A short mono label in capitals: a status, a role, a version.

import { Badge, EnvTag } from "@forgeron/ui";
/01 → Tones
DraftOwnerLivePendingFailed
import { Badge } from "@forgeron/ui";

export default function Tones() {
  return (
    <>
      <Badge>Draft</Badge>
      <Badge tone="strong">Owner</Badge>
      <Badge tone="success" dot>
        Live
      </Badge>
      <Badge tone="warning" dot>
        Pending
      </Badge>
      <Badge tone="danger" dot>
        Failed
      </Badge>
    </>
  );
}
/02 → Identifiers
v1.4.0crm.contacts.list
import { Badge } from "@forgeron/ui";

export default function Identifiers() {
  return (
    <>
      <Badge mono>v1.4.0</Badge>
      <Badge mono>crm.contacts.list</Badge>
    </>
  );
}
/03 → Channels
ProductionBetafeat/invoices
import { EnvTag } from "@forgeron/ui";

export default function Channels() {
  return (
    <>
      <EnvTag env="production" />
      <EnvTag env="channel">Beta</EnvTag>
      <EnvTag env="preview">feat/invoices</EnvTag>
    </>
  );
}
API → Props
PropTypeDefaultDescription
tone"neutral" | "strong" | "success" | "warning" | "danger""neutral"The colour of the state.
dotboolean—A square LED before the text.
monoboolean—Keeps the case of an identifier.
env (EnvTag)"production" | "channel" | "preview"—The channel of a version, told by shape.
classNamestring—Extra classes.