SPB Git

Repository Public License

design-system.md 7.5 KB

# ORIX design system

The design system is the ORIXDesign library in Packages/ORIXKit/Sources/ORIXDesign/. It depends only on SwiftUI (and UIKit or AppKit for dynamic colours and haptics), knows nothing about documents, and is meant to be imported by other ORIX apps as it is.

File Content
Tokens.swift Colour roles, accent pair, spacing, radii, motion, typography, environment key
Components.swift Surfaces, button styles, glyph, section header, chip, empty state, banner, progress bar, page frame, scan beam, mark
Haptics.swift ORIXHaptics

# Tokens

# Colour roles — ORIX.Palette

Every colour is a role with a light and a dark value (Color(light:dark:), sRGB).

Role Light Dark Use
canvas #F4F5FA #0A0D18 App background behind grouped content
surface #FFFFFF #141828 Cards and rows
surfaceRaised #EEF0F7 #1D2236 Fields inside cards, chips, tool buttons
desk #E4E7F0 #05070E Backdrop behind document pages; never pure white, so page edges stay visible
hairline #DDE0EA #262C42 Borders and separators
textPrimary #0E1222 #F2F4FB Main text
textSecondary #596078 #A3AAC2 Supporting text
textTertiary #8A90A6 #6F7690 Placeholders, inactive marks
success #12925A #34D399 Completed, good
warning #B86A00 #FBBF24 Advice, uncertain values
danger #D4313F #FF6B76 Errors, destructive
onAccent white white Content on the accent gradient

# Accent — ORIXAccent

The family shares every token above; each app brings one accent pair.

Light Dark
ORIXAccent.scan.primary (indigo) #5B5BF0 #8484FF
ORIXAccent.scan.secondary (cyan, the "optical beam") #0FB5CF #22D3EE

gradient is the indigo gradient of primary surfaces (#7673FF → #5B5BF0 → #3F3BD6); beam fades the secondary colour in and out horizontally. Components read the accent from the environment (\.orixAccent), never from a constant.

# Spacing — ORIX.Space (4-point scale)

xxs 4 · xs 8 · sm 12 · md 16 · lg 20 · xl 28 · xxl 40

# Radii — ORIX.Radius (continuous corners)

page 5 (paper is almost square) · chip 10 · control 14 · card 20 · hero 28

# Typography

All styles are built on Dynamic Type text styles, so they follow the user's text size.

Token Definition
Font.orixDisplay .largeTitle, rounded, bold
Font.orixTitle .title2, rounded, semibold
Font.orixHeadline .headline, semibold
Font.orixBody .body
Font.orixCallout .callout
Font.orixCaption .caption, medium
Font.orixOverline .caption2, semibold
Font.orixMono .footnote, monospaced (measured values, patterns)

# Motion — ORIX.Motion

Token Curve Use
quick snappy(duration: 0.22) State changes of controls
standard smooth(duration: 0.35) Layout changes, content moving
expressive spring(response: 0.5, dampingFraction: 0.72) Emphasis: the detected crop snapping into place

ORIX.minimumTarget is 44 points.

# Components

Card — the standard surface: surface fill, card radius, hairline border.

swift
VStack { … }.orixCard()            // default padding ORIX.Space.md

Lift — the single elevation used under pages and floating controls: .orixLift().

Button styles

swift
Button("Recognize Text") { … }.buttonStyle(.orixPrimary)     // accent gradient, 52 pt high, the main action of a screen
Button("Import Files") { … }.buttonStyle(.orixSecondary)     // tinted fill
Button { … } label: { … }.buttonStyle(.orixTile)             // card-like tile for quick actions

ORIXGlyph — an SF Symbol on a tinted rounded square; the leading mark of rows and tiles. Hidden from VoiceOver.

swift
ORIXGlyph("folder", size: 32)
ORIXGlyph("wand.and.stars", tint: accent.secondary)

ORIXSectionHeader — a title with the header trait and an optional trailing view.

swift
ORIXSectionHeader("Recent Documents") { Button("See All") { … } }

ORIXChip — compact status or metadata.

swift
ORIXChip(Text("32 lines"), systemName: "text.alignleft")

ORIXEmptyState — symbol, title, message and optional actions, centered.

swift
ORIXEmptyState(systemName: "books.vertical", title: "Your Library Is Empty", message: "Scan a document…") {
    Button("Scan Document") { … }.buttonStyle(.orixPrimary)
}

ORIXBanner — inline message of kind info, success, warning or error. Each kind has its own symbol as well as its own colour, and the banner is one accessibility element.

swift
ORIXBanner(.warning, title: Text("Low contrast"), message: Text("Try the Black & White filter…")) { Menu { … } label: { … } }

ORIXProgressBar — determinate progress with the indigo-to-cyan gradient; exposes its value as a percentage.

swift
ORIXProgressBar(value: progress)

Page frame — frames an image as paper: near-square corners, a hairline, the lift.

swift
Image(uiImage: page).resizable().aspectRatio(contentMode: .fit).orixPage()

Scan beam — the ORIX signature: a thin luminous line sweeping over content while it is being processed.

swift
DocumentThumbnail(id: id).orixScanBeam(active: isRecognizing)

ORIXMark — the mark drawn in code with Canvas: four viewfinder arcs forming the "O", crossed by the beam.

swift
ORIXMark().frame(width: 96)
ORIXMark(ring: .white)             // on the accent gradient

ORIXHaptics — tick() for a discrete change, press() for a physical-feeling action, success(), warning(), failure() for outcomes. No-ops where UIKit is unavailable.

# Accessibility rules built in

  • Dynamic Type. Every font token is a text style; no fixed point sizes for text. Layouts that cannot hold large text side by side switch axis (HomeView uses dynamicTypeSize.isAccessibilitySize).
  • Targets. Interactive elements are at least ORIX.minimumTarget (44 pt): primary buttons are 52 pt high, secondary 48 pt, icon buttons 44 × 44.
  • Reduce Motion. ORIXScanBeam does not animate when accessibilityReduceMotion is on.
  • Never colour alone. Banners pair colour with a symbol and text; chips and status rows carry a label; selected states also set the isSelected trait.
  • Decoration is hidden. ORIXGlyph, ORIXMark, chip icons and the beam are hidden from VoiceOver; the progress bar and banners are single elements with a value or a combined label.
  • Light and dark. All palette roles have both values; nothing in the system uses a fixed black or white for text.

# Adopting the system in another ORIX app

  1. Add the package and import ORIXDesign.
  2. Define the app's accent pair and inject it once at the root:
swift
extension ORIXAccent {
    static let audio = ORIXAccent(primary: Color(light: 0x…, dark: 0x…), secondary: Color(light: 0x…, dark: 0x…))
}

RootView()
    .environment(\.orixAccent, .audio)
    .tint(ORIXAccent.audio.primary)
  1. Use the tokens and components unchanged. Everything that is accent-coloured follows the environment value.

Two things are still specific to ORIX Scan and would need generalizing for a second app: the fixed stops of ORIXAccent.gradient, and the default value of the environment key (.scan).

Files main
Menu

Theme