Krizaka
Documentation

Landscape

The Krizaka valley at dusk — peaks, a phoenix over a river of two flames, trees of light and the flock at work: a decorative backdrop in its own colours or in the host brand's.

WebBêtaBlocs

Web uniquement — React, depuis @krizaka/ui/landscape. Bêta : son API peut encore changer à une version mineure.

Quand l’utiliser

  • Behind the end of a told page or a home's first screen, under the last words.
  • A product's about page, in its own accents (tone="brand", flock={false} for a calmer one).

Quand ne pas l’utiliser

  • Behind a section's content: the brand's gradient and grid are the section backdrop.À la place : Section backdrop
  • In a working screen, or behind text that must be read.

Installation

Installer

npm install @krizaka/ui @krizaka/tailwind @krizaka/tokens tailwindcss

Styles

@import "tailwindcss";
@import "@krizaka/tailwind";
@import "@krizaka/ui/tailwind.css";

Importer

import { Landscape } from "@krizaka/ui/landscape";

Exemples

A page's end

The valley behind the last words, faded into the surface.

Built in the open, in Montréal.

In the brand's colours

tone="brand" without the flock: the sky and the peaks in the host's accents.

Props

The Krizaka landscape: a decorative backdrop for a hero or a page's end (aria-hidden).

PropTypeDéfautDescription
animatedbooleantrueThe slow loops (the sun, the stars, the flames, the birds). false holds the first frame; always held under prefers-reduced-motion and while off screen (with MotionObserver).
fadebooleantrueFades the bottom into the page's surface.
flockbooleantrueThe flock at work in the valley (hidden under 1024 px wide either way).
phoenixbooleantrueThe phoenix and its river of two flames.
position"absolute" | "relative"absoluteabsolute: fills its positioned parent, anchored at the bottom (a backdrop). relative: a block in the flow — give it a height.
tone"brand" | "own"ownown: the Krizaka dusk (indigo, cyan and magenta peaks). brand: the sky and the peaks in the host brand's accents (.brand-<id>). The birds and the phoenix keep their own colours.

Accessibilité

  • Decorative (aria-hidden): it never carries information.
  • Every loop holds its first frame under prefers-reduced-motion, with animated={false}, and while off screen.

Bonnes pratiques

  • Place it at the bottom of a positioned parent with room under the words; it fades into the surface.
  • Hold it still (animated={false}) on a page that already moves; it pauses off screen with MotionObserver.
  • The birds are hidden under 1024 px: on a phone the valley stays calm.

Générée depuis le code de @krizaka/ui 2.10.0 : son meta.ts, ses exemples et ses types.Modifier cette documentation sur GitHub

Sur cette page