Skip to the content

Toranpuトランプ

Use a deck, play eleven games with computers, solve a solitaire, or display cards in your own design.

Toranpu is Japanese for playing cards. About the name

Contents

Reference · Card designs

CardFaceOptionstype

How a face is drawn. Every field may be left out.

Import it

import type { CardFaceOptions } from "@johnmorrisdotca/toranpu/card-faces";

Definition

type CardFaceOptions = {
    design?: "plain" | "four-colour" | CardDesign | (string & {});
    width?: number;
    title?: string;
    language?: Language;
};

Members

NameTypeDescription
design (optional)"plain" | "four-colour" | CardDesign | (string & {}) | undefined

"plain" (unless said), "four-colour", a design handed in, such as ENGLISH_PATTERN, or the name of a design the page has registered (registerCardDesign).

width (optional)number | undefined

The width to draw at, in pixels; the height is 1.4 times it. Unless said, the drawing fills what holds it.

title (optional)string | undefined

What a screen reader says. Unless said, the card's name in language, "queen of spades". An empty string makes it decoration.

language (optional)Language | undefined

The language of the card's name, and of a joker's corner word: "en" (unless said) or "ja".

Examples

import type { CardFaceOptions } from "@johnmorrisdotca/toranpu/card-faces";

const value: CardFaceOptions = { design: "four-colour", width: 80, language: "ja" };
console.log(value.design);
four-colour

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/toranpu 2.15.0.