Skip to content
UI Brok

Loading…

No results

Browse catalog

Citation

Inline citation chip with a numbered badge, excerpt, and a source that links when set.

Preview

1 Self-attention scales quadratically with sequence length. arxiv.org 2 Rotary embeddings improve length generalisation. blog.example.com

Controls

Theme
Surface
Direction
Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal
php artisan ui:add citation

Registry contract

Install confidence

php artisan ui:add citation writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version
2.0.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/citation.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Compact label and metadata

Communicate concise status, count, or metadata.

Use when

  • Use for compact labels, counts, and concise metadata that support scanning. Do not force badges or short labels to carry complex explanations that need sentence-level context.

Avoid when

  • Avoid using citation as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
Task length
micro
Interaction cost
low
Interruptiveness
none
Input precision
none
Mobile / touch risk
low
Accessibility risk
medium
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Visible explanatory text

Anti-patterns

  • Encoding complex meaning in a badge alone

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
number int 1 Declared by @props in the registry Blade source.
excerpt string …relevant quoted text… Declared by @props in the registry Blade source.
source string example.com Declared by @props in the registry Blade source.
href mixed|null null Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

citation

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.citation.default.blade.php Blade
<div class="flex flex-wrap justify-center gap-2">
    <x-ui.citation :number="1" excerpt="Self-attention scales quadratically with sequence length." source="arxiv.org" href="#" />
    <x-ui.citation :number="2" excerpt="Rotary embeddings improve length generalisation." source="blog.example.com" />
</div>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels
  • Accessibility target: wcag-2.2-aa-target.
  • Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
  • Focus-visible rings use the ring token so keyboard focus is always visible.
  • Disabled and invalid states are conveyed to assistive tech, not by color alone.
  • Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
  • Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v2.0.0. See the site changelog for the full release history.