API reference
blocks/release-tag
Import
Section titled “Import”import * as api from "@fungi.computer/caps/blocks/release-tag";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | ReleaseTagEntry | One shipped thing and its version, printed under the tag. |
| type alias | ReleaseTagProps | Props accepted by ReleaseTag. |
| function | ReleaseTag() | A release badge: a torn-off calendar page with binder rings, a stacked title, one accent strip and a ruled list of names and versions below. Presentation only; the caller supplies every word. |
ReleaseTagEntrytype alias
Section titled “ReleaseTagEntry”type ReleaseTagEntry = Readonly<{ name: string; version: string;}>;One shipped thing and its version, printed under the tag.
ReleaseTagPropstype alias
Section titled “ReleaseTagProps”type ReleaseTagProps = Omit<HTMLAttributes<HTMLElement>, "title"> & object;Props accepted by ReleaseTag.
Type Declaration
Section titled “Type Declaration”| Name | Type | Description |
|---|---|---|
title |
readonly string[] |
One or two short lines printed large on the tag, such as [“Fungi”, “Beta”]. |
label? |
ReactNode |
A small accent strip under the title, such as “Update”. |
entries |
readonly ReleaseTagEntry[] |
- |
ReleaseTag()function
Section titled “ReleaseTag()”function ReleaseTag(__namedParameters): Element;A release badge: a torn-off calendar page with binder rings, a stacked title, one accent strip and a ruled list of names and versions below. Presentation only; the caller supplies every word.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
__namedParameters |
ReleaseTagProps |
Returns
Section titled “Returns”Element