Skip to main content

public-product pattern

ReleaseStatusBanner

State release, preview, limitation, or maintenance status with a dated evidence link.

complyeaze/core · candidate · @sanchika/patterns

Product job

Determine whether a named release artifact supports the intended use and what limitation remains.

State release, preview, limitation, or maintenance status with a dated evidence link.

Anatomy and required fields

status

Visible release state.

productPackage

Product or package whose status is being shown.

releaseVersion

Current release, version, artifact, or explicit unreleased status.

scope

Affected product or artifact.

effectiveAt

Status date or maintenance window.

source

Inspectable release or source artifact.

supportedScope

What the release evidence supports.

knownLimitation

What remains unavailable or unproven.

safeAction

Review, update, or fallback action.

Required fields
  • productPackage
  • releaseVersion
  • scope
  • effectiveAt
  • status
  • source
  • supportedScope
  • knownLimitation
  • safeAction

Default and edge states

current

Release evidence is current.

  • current
  • version or artifact
  • evidence
alpha

The release is explicitly pre-stable.

  • alpha
  • supported scope
  • limitation
stale

The release evidence needs a new source check.

  • stale
  • last reviewed
  • refresh action
limited

A release limitation affects use.

  • limited
  • scope
  • fallback
planned

The release is planned but not available.

  • planned
  • no release claim
  • source
unavailable

No supported release artifact is available.

  • unavailable
  • reason
  • safe action

Composed synthetic exemplar

State coverage

Default and consequential edges remain inspectable.

currentRelease evidence is current.current · version or artifact
alphaThe release is explicitly pre-stable.alpha · supported scope
staleThe release evidence needs a new source check.stale · last reviewed
limitedA release limitation affects use.limited · scope
plannedThe release is planned but not available.planned · no release claim
unavailableNo supported release artifact is available.unavailable · reason

Trust, source, and consumer obligations

Trust boundaries
  • Do not imply government affiliation, guaranteed outcomes, or unstated production readiness.
  • Name account, upload, local-processing, external-destination, and human-review boundaries before action.
Consumer owns
  • Supply current product copy, sources, destinations, prices, review ownership, and all runtime behavior.
Responsive behavior
  • Stack status metadata before actions on narrow screens.
  • Keep date and evidence link untruncated.
Forced colors and reduced motion
  • Retain labelled boundaries, native link underlines, focus outlines, and status text without authored color.
  • Keep all claims, proof, boundaries, and actions visible without entrance or layout motion.

Compact API reference

Package
@sanchika/patterns
CSS
@sanchika/patterns/styles.css
Base class
sk-pattern-release-status-banner
Group
public-product