@gjermundgaraba/pixel-paper 0.0.0-stage → 0.1.0

package/dist/glyph/glyphs.d.ts

@@ -0,0 +1,381 @@
+import { Record } from "effect";
+/**
+ * The glyph inventory, in families. Every glyph is drawn as it prints: twelve rows of twelve
+ * cells, `#` inked and `.` blank, on one 12x12 grid, so the whole set shares one weight and
+ * one grammar, with no curves and no other icon style. The rules for drawing a new one are in
+ * DESIGN.md (The Pixel Glyph Rule). A name is unique across every family.
+ */
+export declare const glyphFamilies: {
+  /** Where something goes: carets, arrows, the ends of a sequence. */
+  direction: {
+    /** Open disclosure; a menu that opens below. */
+    "caret-down": string;
+    /** Closed disclosure. */
+    "caret-right": string;
+    /** A menu that opens above; a column sorted ascending. */
+    "caret-up": string;
+    /** Up: move earlier, raise. */
+    "arrow-up": string;
+    /** Down: move later, lower. */
+    "arrow-down": string;
+    /** Left: the previous one. */
+    "arrow-left": string;
+    /** Right: the next one, go. */
+    "arrow-right": string;
+    /** Out to somewhere else; a rise. */
+    "arrow-up-right": string;
+    /** Back to where you came from; the step before (a caret pointing left). */
+    back: string;
+    /** What links here. */
+    backlink: string;
+    /** Opens elsewhere; drawn at 10px beside text. */
+    external: string;
+    /** Nested under the line above; a reply. */
+    "corner-down-right": string;
+    /** Confirm with Enter; a line break. */
+    enter: string;
+    /** Exchange two things; transfer both ways. */
+    swap: string;
+    /** Move freely: drag in any direction. */
+    move: string;
+    /** A column that sorts: the arrows say which way once it does. */
+    sort: string;
+    /** Take the whole stage. */
+    expand: string;
+    /** Back to its place. */
+    shrink: string;
+    /** Send a file up. */
+    upload: string;
+    /** Bring a file down. */
+    download: string;
+    /** To the start; the first page. */
+    "skip-back": string;
+    /** To the end; the last page. */
+    "skip-next": string;
+  };
+  /** What a control does. */
+  actions: {
+    /** Add, create. */
+    plus: string;
+    /** Remove one; fold. */
+    minus: string;
+    /** Close, dismiss, clear. */
+    cross: string;
+    /** Done, confirmed, selected. */
+    check: string;
+    /** Edit, rename. */
+    pencil: string;
+    /** Copy to the clipboard. */
+    copy: string;
+    /** Paste; what was copied. */
+    clipboard: string;
+    /** Delete: always behind a confirm. */
+    trash: string;
+    /** Save; a draft kept. */
+    save: string;
+    /** Search, find. */
+    search: string;
+    /** Closer. */
+    "zoom-in": string;
+    /** Further. */
+    "zoom-out": string;
+    /** Narrow what is shown. */
+    filter: string;
+    /** More actions, in a menu. */
+    more: string;
+    /** More actions, where a row is narrow. */
+    "more-vertical": string;
+    /** Settings: sliders to adjust. */
+    settings: string;
+    /** Configuration, the machinery behind. */
+    gear: string;
+    /** Take the last change back. */
+    undo: string;
+    /** Make the undone change again. */
+    redo: string;
+    /** Bring two sides level. */
+    sync: string;
+    /** Read it again from the source. */
+    refresh: string;
+    /** A link; copy its address. */
+    link: string;
+    /** Break a link. */
+    unlink: string;
+    /** Keep at the top; pinned. */
+    pin: string;
+    /** Send it on its way. */
+    send: string;
+    /** Sign in. */
+    "log-in": string;
+    /** Sign out. */
+    "log-out": string;
+  };
+  /** What something is: attention, choice, marks, locks, time. */
+  state: {
+    /** Needs attention: a warning, a question to answer. */
+    bang: string;
+    /** Something to know; nothing wrong. */
+    info: string;
+    /** Help; not known yet. */
+    question: string;
+    /** A risk ahead: a limit near, a change that cannot be undone. */
+    warning: string;
+    /** Not allowed; blocked. */
+    ban: string;
+    /** Unsaved. */
+    dot: string;
+    /** The viewfinder: marked for attention (the Mark component fills it amber). */
+    mark: string;
+    /** A group, unfolded. */
+    ring: string;
+    /** A group, folded. */
+    "ring-closed": string;
+    /** An item, open. */
+    box: string;
+    /** An item, closed. */
+    "box-done": string;
+    /** A round shape; a choice not taken. */
+    circle: string;
+    /** A favourite. */
+    star: string;
+    /** Kept to come back to. */
+    bookmark: string;
+    /** Flagged; a milestone. */
+    flag: string;
+    /** Notifications. */
+    bell: string;
+    /** Notifications muted. */
+    "bell-off": string;
+    /** Shown: a secret revealed. */
+    eye: string;
+    /** Hidden: a secret masked. */
+    "eye-off": string;
+    /** Locked; private; signed in. */
+    lock: string;
+    /** Unlocked; open to change. */
+    unlock: string;
+    /** A time; how long ago. */
+    clock: string;
+    /** Waiting; pending; a limit that resets. */
+    hourglass: string;
+    /** Made or suggested by a model. */
+    spark: string;
+    /** The paper palette; light. */
+    sun: string;
+    /** The plum palette; dark. */
+    moon: string;
+    /** Follow the system's palette. */
+    contrast: string;
+  };
+  /** Playing, recording, sound and pictures. */
+  media: {
+    /** Start or resume. */
+    play: string;
+    /** Hold where it is. */
+    pause: string;
+    /** Stop for good. */
+    stop: string;
+    /** Recording; live. */
+    record: string;
+    /** On or off. */
+    power: string;
+    /** A microphone; dictation. */
+    mic: string;
+    /** Microphone muted. */
+    "mic-off": string;
+    /** Sound on. */
+    volume: string;
+    /** Sound off. */
+    "volume-off": string;
+    /** A picture. */
+    image: string;
+    /** Captions: the words of what plays, over the picture. */
+    captions: string;
+  };
+  /** How a screen is arranged, and the canvas tools. */
+  layout: {
+    /** The outline layout. */
+    outline: string;
+    /** A plain list. */
+    list: string;
+    /** The menu; rows. */
+    bars: string;
+    /** The board layout. */
+    columns: string;
+    /** A grid of equal cells. */
+    grid: string;
+    /** A space of cards. */
+    tiles: string;
+    /** A table. */
+    table: string;
+    /** Fit to the frame. */
+    fit: string;
+    /** The rail, shown or folded away. */
+    sidebar: string;
+    /** A panel beside, on the right. */
+    "panel-right": string;
+    /** A panel below: a log, a console. */
+    "panel-bottom": string;
+    /** Two panes side by side. */
+    split: string;
+    /** A window on the stage. */
+    window: string;
+    /** Layers; what lies on top of what. */
+    layers: string;
+    /** Take hold to move: two columns of three cells. */
+    grip: string;
+    /** Select: the pointer tool. */
+    pointer: string;
+    /** Pan: the hand tool. */
+    hand: string;
+    /** Text: the type tool. */
+    text: string;
+  };
+  /** Pages, folders and what is written in them. */
+  documents: {
+    /** A document. */
+    page: string;
+    /** A new document. */
+    "file-plus": string;
+    /** A note. */
+    note: string;
+    /** A script; something that runs. */
+    script: string;
+    /** A folder, closed. */
+    folder: string;
+    /** A folder, open. */
+    "folder-open": string;
+    /** A new folder. */
+    "folder-plus": string;
+    /** A set. */
+    stack: string;
+    /** Archived: kept, out of the way. */
+    archive: string;
+    /** What came in. */
+    inbox: string;
+    /** Something placed inside another thing. */
+    embed: string;
+    /** A reference: the wiki, the docs. */
+    book: string;
+    /** A heading. */
+    heading: string;
+    /** A quotation. */
+    quote: string;
+    /** Code. */
+    code: string;
+    /** A number; a channel; a section. */
+    hash: string;
+    /** Dated items. */
+    calendar: string;
+  };
+  /** Who: people, identities, agents, places. */
+  people: {
+    /** A person: an owner, a session. */
+    user: string;
+    /** People: members, a team. */
+    users: string;
+    /** Invite a person. */
+    "user-plus": string;
+    /** An identity: a client, a credential. */
+    "id-card": string;
+    /** A key, a secret, an API credential. */
+    key: string;
+    /** Protected; a policy. */
+    shield: string;
+    /** Verified; allowed by policy. */
+    "shield-check": string;
+    /** An agent; something that acts on its own. */
+    bot: string;
+    /** Mail; a message. */
+    mail: string;
+    /** A conversation; a comment. */
+    chat: string;
+    /** An address on the network. */
+    globe: string;
+    /** Home; the start. */
+    home: string;
+    /** A place. */
+    location: string;
+  };
+  /** Machines, connections and builds. */
+  systems: {
+    /** A terminal. */
+    terminal: string;
+    /** A machine; a server. */
+    machine: string;
+    /** A source items come from. */
+    drum: string;
+    /** Compute; a processor. */
+    chip: string;
+    /** A network; a hierarchy. */
+    network: string;
+    /** Hosted; in the cloud. */
+    cloud: string;
+    /** Not synced; offline from the host. */
+    "cloud-off": string;
+    /** Connected. */
+    wifi: string;
+    /** Offline. */
+    "wifi-off": string;
+    /** A connection to something outside. */
+    plug: string;
+    /** An extension. */
+    puzzle: string;
+    /** A package; a build. */
+    package: string;
+    /** Deploy; launch. */
+    rocket: string;
+    /** A bug; a fault. */
+    bug: string;
+    /** An experiment; not stable yet. */
+    flask: string;
+    /** A desktop; a screen. */
+    monitor: string;
+    /** A phone. */
+    phone: string;
+    /** Keys; the keymap. */
+    keyboard: string;
+  };
+  /** Revisions and how they relate. */
+  versions: {
+    /** A line of revisions. */
+    branch: string;
+    /** Two lines made one. */
+    merge: string;
+    /** One line made two. */
+    fork: string;
+    /** A revision. */
+    commit: string;
+    /** What changed: added and removed. */
+    diff: string;
+    /** A checkpoint of a state. */
+    snapshot: string;
+    /** A category, a label. */
+    tag: string;
+  };
+  /** Amounts, trends and money. */
+  readings: {
+    /** Amounts side by side. */
+    "chart-bar": string;
+    /** Rising. */
+    "trend-up": string;
+    /** Falling. */
+    "trend-down": string;
+    /** Activity over time. */
+    activity: string;
+    /** A share; a rate. */
+    percent: string;
+    /** Power used; fast. */
+    bolt: string;
+    /** What is left. */
+    battery: string;
+    /** A payment card; billing. */
+    card: string;
+    /** A receipt; a charge. */
+    receipt: string;
+  };
+};
+type Families = typeof glyphFamilies;
+/** The name of one glyph in the inventory, such as `"caret-down"` or `"bolt"`. */
+export type GlyphName = { [Family in keyof Families]: keyof Families[Family]; }[keyof Families];
+export {};