Lily Design System™

Hong Kong Identity Card View

HongKongIdentityCardView is a headless read-only display of Hong Kong's Identity Card Number, Hong Kong's government-issued personal identifier. It renders as a <span> with an accessible label. It is the read-only companion to HongKongIdentityCardInput.

Status: beta — implemented and unit-tested in all seven frameworks; not yet exercised in a composed flow.

Example

HongKongIdentityCardView
Show demo markup 
<div class="hong-kong-identity-card-view" aria-label="a read-only display of Hong Kong's Hong Kong Identity Card Number">HongKongIdentityCardView</div>
Usage example 
<HongKongIdentityCardView label="HongKongIdentityCardView example"
  >Content</HongKongIdentityCardView
>
Show Svelte source 
// In your Svelte component:
import HongKongIdentityCardView from "lily-design-system-svelte-headless/components/HongKongIdentityCardView/HongKongIdentityCardView.svelte";

<HongKongIdentityCardView>
  <!-- content -->
</HongKongIdentityCardView>

Usage

<SummaryList>
  <SummaryListItem term="Hong Kong Identity Card Number">
    <HongKongIdentityCardView
      label="Hong Kong Identity Card Number"
      value="{value}"
    />
  </SummaryListItem>
</SummaryList>

Props

  • value: string (default: "") — the identifier to display
  • label: string (required) — accessible label via aria-label
  • ...restProps: any — additional HTML attributes spread onto the <span>

ARIA

  • aria-label={label} — provides the accessible name

When to Use

  • Use to display a stored Hong Kong Identity Card Number read-only.
  • Use in summary lists, patient records, audit logs, or detail views.
  • Use when the identifier should not be editable in the current context.

When Not to Use

  • Do not use for editing identifiers — use hong-kong-identity-card-input instead.
  • Do not use for general text display — use a <span> directly.
  • Do not use for other countries' identifiers — use the corresponding country-specific view.

Headless

This headless component ships zero CSS. The consumer provides all styling targeting the .hong-kong-identity-card-view class hook.

Testing

  • Verify renders a <span> with the correct class
  • Verify the value prop is rendered as text content
  • Verify aria-label is set from the label prop

Domain Knowledge

One or two letters, six digits and a check digit in parentheses, such as A123456(3). The check digit is 0 to 9 or A. Each letter counts as A=10 to Z=35, and a single letter is preceded by a space counted as 36; the eight values are multiplied by 9,8,7,6,5,4,3,2 and summed, and the check digit is 11 minus the sum's Modulus-11 remainder (0 when the remainder is 0, and A when the result is 10).

Where to find it: Printed on the Hong Kong Identity Card, and asked for by hospitals, clinics, banks, employers and government services.

Related components

  • hong-kong-identity-card-input — an input for entering Hong Kong's Identity Card Number
  • summary-list-item — one key-value pair in a summary list

References

Lily™ and Lily Design System™ are trademarks.

Implementation Notes

  • Renders as <span>
  • Format: One or two letters, six digits and a check digit in parentheses, such as A123456(3). The check digit is 0 to 9 or A. Each letter counts as A=10 to Z=35, and a single letter is preceded by a space counted as 36; the eight values are multiplied by 9,8,7,6,5,4,3,2 and summed, and the check digit is 11 minus the sum's Modulus-11 remainder (0 when the remainder is 0, and A when the result is 10).
  • Provides accessible name via the label prop
  • Companion to HongKongIdentityCardInput

Canonical contract

Generated from this component's canonical metadata — the machine-checked source the implementations are held to.

Metadata

  • Component: hong-kong-identity-card-view
  • PascalCase: HongKongIdentityCardView
  • Description: a read-only display of Hong Kong's Identity Card Number
  • Status: beta — implemented and unit-tested in all seven frameworks; not yet exercised in a composed flow
  • HTML tag: <span>
  • CSS class: .hong-kong-identity-card-view
  • Interactive: no

ARIA

  • aria-label provides accessible name from label prop

Keyboard

  • Not interactive

Props

  • value: string (default: "") — the identifier to display
  • label: string (required) — accessible name via aria-label
  • ...restProps: any additional HTML attributes spread onto the root

Markdown

This page as Markdown, for people and AI tools: hong-kong-identity-card-view.md