@deriv-com/dds-marketing 1.1.3 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.llm/components/accordion.md +6 -0
- package/.llm/components/accordionitem.md +6 -0
- package/.llm/components/aspectratio.md +6 -0
- package/.llm/components/awards.md +6 -0
- package/.llm/components/background.md +49 -10
- package/.llm/components/badge.md +6 -0
- package/.llm/components/bottomsheet.md +6 -0
- package/.llm/components/breadcrumb.md +6 -0
- package/.llm/components/breadcrumbitem.md +6 -0
- package/.llm/components/button.md +9 -3
- package/.llm/components/buttonicon.md +7 -1
- package/.llm/components/card.md +6 -0
- package/.llm/components/cardbody.md +7 -1
- package/.llm/components/cardbutton.md +6 -0
- package/.llm/components/checkbox.md +6 -0
- package/.llm/components/comparisoncards.md +9 -3
- package/.llm/components/comparisontable.md +6 -0
- package/.llm/components/ctabanner.md +6 -0
- package/.llm/components/ctabannerslider.md +6 -0
- package/.llm/components/datatable.md +6 -0
- package/.llm/components/divider.md +6 -0
- package/.llm/components/documentlink.md +237 -0
- package/.llm/components/documents.md +268 -0
- package/.llm/components/downloadbanner.md +7 -1
- package/.llm/components/dropdownmenu.md +6 -0
- package/.llm/components/estimator.md +6 -0
- package/.llm/components/faqaccordion.md +6 -0
- package/.llm/components/featurebullets.md +6 -0
- package/.llm/components/featurecards.md +42 -2
- package/.llm/components/featurecardscarousel.md +7 -1
- package/.llm/components/featurescroll.md +6 -0
- package/.llm/components/featuresplit.md +6 -0
- package/.llm/components/featurestack.md +6 -0
- package/.llm/components/featuretabs.md +369 -0
- package/.llm/components/filterchip.md +6 -0
- package/.llm/components/footer.md +6 -0
- package/.llm/components/footergroup.md +6 -0
- package/.llm/components/grid.md +30 -1
- package/.llm/components/icon.md +6 -0
- package/.llm/components/illustrationcard.md +52 -2
- package/.llm/components/illustrationcheck.md +193 -0
- package/.llm/components/illustrationchoice.md +187 -0
- package/.llm/components/illustrationcode.md +192 -0
- package/.llm/components/illustrationlist.md +175 -0
- package/.llm/components/illustrationscene.md +29 -3
- package/.llm/components/imagebanner.md +30 -5
- package/.llm/components/landinghero.md +6 -0
- package/.llm/components/link.md +7 -1
- package/.llm/components/logocolumns.md +7 -1
- package/.llm/components/logorows.md +42 -2
- package/.llm/components/menuitem.md +6 -0
- package/.llm/components/navbar.md +6 -0
- package/.llm/components/navbaritem.md +6 -0
- package/.llm/components/navbarmenu.md +6 -0
- package/.llm/components/navbarmenugroup.md +6 -0
- package/.llm/components/navbarpanel.md +6 -0
- package/.llm/components/navbarswitcher.md +6 -0
- package/.llm/components/navbarswitcheroption.md +6 -0
- package/.llm/components/option.md +6 -0
- package/.llm/components/pageheader.md +6 -0
- package/.llm/components/pagination.md +6 -0
- package/.llm/components/paginationdots.md +6 -0
- package/.llm/components/producthero.md +6 -0
- package/.llm/components/progressbar.md +305 -0
- package/.llm/components/removablechip.md +6 -0
- package/.llm/components/resourcebanner.md +6 -0
- package/.llm/components/row.md +6 -0
- package/.llm/components/scenescroll.md +38 -24
- package/.llm/components/scenescrollword.md +267 -0
- package/.llm/components/scroller.md +6 -0
- package/.llm/components/searchinput.md +6 -0
- package/.llm/components/segmentedcontrol.md +28 -1
- package/.llm/components/segmentedcontrolitem.md +6 -0
- package/.llm/components/select.md +6 -0
- package/.llm/components/selectchip.md +6 -0
- package/.llm/components/spinner.md +6 -0
- package/.llm/components/stack.md +6 -0
- package/.llm/components/stats.md +46 -1
- package/.llm/components/statscarousel.md +227 -0
- package/.llm/components/statusdot.md +41 -1
- package/.llm/components/steps.md +6 -0
- package/.llm/components/stickycards.md +6 -0
- package/.llm/components/subdomainnavbar.md +6 -0
- package/.llm/components/tab.md +6 -0
- package/.llm/components/table.md +6 -0
- package/.llm/components/tablebody.md +6 -0
- package/.llm/components/tablecell.md +6 -0
- package/.llm/components/tablehead.md +6 -0
- package/.llm/components/tableheadercell.md +6 -0
- package/.llm/components/tablerow.md +6 -0
- package/.llm/components/tablist.md +6 -0
- package/.llm/components/teamgrid.md +6 -0
- package/.llm/components/testimonialrow.md +43 -3
- package/.llm/components/testimonialslider.md +8 -2
- package/.llm/components/textarea.md +6 -0
- package/.llm/components/textinput.md +6 -0
- package/.llm/components/textscroll.md +6 -0
- package/.llm/components/tiers.md +13 -7
- package/.llm/components/tooltip.md +6 -0
- package/.llm/components/typography.md +63 -1
- package/.llm/digest/background.md +14 -6
- package/.llm/digest/button.md +1 -1
- package/.llm/digest/buttonicon.md +1 -1
- package/.llm/digest/documentlink.md +52 -0
- package/.llm/digest/documents.md +51 -0
- package/.llm/digest/downloadbanner.md +1 -1
- package/.llm/digest/featurecards.md +7 -0
- package/.llm/digest/featuretabs.md +50 -0
- package/.llm/digest/grid.md +1 -0
- package/.llm/digest/illustrationcard.md +6 -1
- package/.llm/digest/illustrationcheck.md +42 -0
- package/.llm/digest/illustrationchoice.md +43 -0
- package/.llm/digest/illustrationcode.md +41 -0
- package/.llm/digest/illustrationlist.md +38 -0
- package/.llm/digest/illustrationscene.md +4 -2
- package/.llm/digest/imagebanner.md +9 -3
- package/.llm/digest/logocolumns.md +1 -1
- package/.llm/digest/logorows.md +8 -1
- package/.llm/digest/progressbar.md +56 -0
- package/.llm/digest/scenescroll.md +6 -5
- package/.llm/digest/scenescrollword.md +56 -0
- package/.llm/digest/segmentedcontrol.md +3 -0
- package/.llm/digest/stats.md +8 -0
- package/.llm/digest/statscarousel.md +48 -0
- package/.llm/digest/statusdot.md +7 -0
- package/.llm/digest/testimonialrow.md +8 -1
- package/.llm/digest/testimonialslider.md +1 -1
- package/.llm/digest/typography.md +18 -0
- package/.llm/index.md +14 -4
- package/.llm/rules.md +10 -0
- package/.llm/tokens.md +12 -3
- package/AGENTS.md +13 -2
- package/dist/components/arrival.d.ts +32 -0
- package/dist/components/arrival.js +140 -0
- package/dist/components/arrives.d.ts +17 -0
- package/dist/components/arrives.js +14 -0
- package/dist/components/blocks/awards/Awards.js +2 -27
- package/dist/components/blocks/block-pattern.css +23 -0
- package/dist/components/blocks/comparison-cards/comparison-cards-impl.css +29 -0
- package/dist/components/blocks/documents/Documents.css +90 -0
- package/dist/components/blocks/documents/Documents.d.ts +22 -0
- package/dist/components/blocks/documents/Documents.js +30 -0
- package/dist/components/blocks/documents/Documents.types.d.ts +37 -0
- package/dist/components/blocks/documents/Documents.types.js +14 -0
- package/dist/components/blocks/documents/documents-impl.css +103 -0
- package/dist/components/blocks/download-banner/DownloadBanner.css +1 -1
- package/dist/components/blocks/download-banner/DownloadBanner.types.d.ts +1 -1
- package/dist/components/blocks/feature-cards/FeatureCards.d.ts +2 -1
- package/dist/components/blocks/feature-cards/FeatureCards.js +10 -7
- package/dist/components/blocks/feature-cards/FeatureCards.types.d.ts +9 -1
- package/dist/components/blocks/feature-cards/feature-cards-impl.css +15 -3
- package/dist/components/blocks/feature-cards-carousel/FeatureCardsCarousel.types.d.ts +1 -1
- package/dist/components/blocks/feature-cards-carousel/feature-cards-carousel-impl.css +12 -0
- package/dist/components/blocks/feature-tabs/FeatureTabs.css +100 -0
- package/dist/components/blocks/feature-tabs/FeatureTabs.d.ts +23 -0
- package/dist/components/blocks/feature-tabs/FeatureTabs.js +38 -0
- package/dist/components/blocks/feature-tabs/FeatureTabs.types.d.ts +35 -0
- package/dist/components/blocks/feature-tabs/FeatureTabs.types.js +14 -0
- package/dist/components/blocks/feature-tabs/feature-tabs-impl.css +53 -0
- package/dist/components/blocks/image-banner/ImageBanner.css +1 -1
- package/dist/components/blocks/image-banner/ImageBanner.d.ts +1 -1
- package/dist/components/blocks/image-banner/ImageBanner.js +2 -2
- package/dist/components/blocks/image-banner/ImageBanner.types.d.ts +9 -7
- package/dist/components/blocks/image-banner/ImageBanner.types.js +1 -1
- package/dist/components/blocks/image-banner/image-banner-impl.css +107 -29
- package/dist/components/blocks/laurel.d.ts +16 -0
- package/dist/components/blocks/laurel.js +28 -0
- package/dist/components/blocks/logo-columns/LogoColumns.css +1 -1
- package/dist/components/blocks/logo-columns/LogoColumns.types.d.ts +1 -1
- package/dist/components/blocks/logo-rows/LogoRows.css +1 -1
- package/dist/components/blocks/logo-rows/LogoRows.d.ts +2 -1
- package/dist/components/blocks/logo-rows/LogoRows.js +7 -4
- package/dist/components/blocks/logo-rows/LogoRows.types.d.ts +9 -1
- package/dist/components/blocks/pattern-tone.d.ts +11 -0
- package/dist/components/blocks/pattern-tone.js +7 -0
- package/dist/components/blocks/resource-banner/ResourceBanner.css +1 -1
- package/dist/components/blocks/scene-scroll/SceneScroll.css +1 -1
- package/dist/components/blocks/scene-scroll/SceneScroll.d.ts +7 -5
- package/dist/components/blocks/scene-scroll/SceneScroll.js +9 -7
- package/dist/components/blocks/scene-scroll/SceneScroll.types.d.ts +5 -5
- package/dist/components/blocks/scene-scroll/SceneScroll.types.js +1 -1
- package/dist/components/blocks/scene-scroll/scene-scroll-impl.css +139 -41
- package/dist/components/blocks/scene-scroll-word/SceneScrollWord.css +105 -0
- package/dist/components/blocks/scene-scroll-word/SceneScrollWord.d.ts +31 -0
- package/dist/components/blocks/scene-scroll-word/SceneScrollWord.js +67 -0
- package/dist/components/blocks/scene-scroll-word/SceneScrollWord.types.d.ts +39 -0
- package/dist/components/blocks/scene-scroll-word/SceneScrollWord.types.js +18 -0
- package/dist/components/blocks/scene-scroll-word/scene-scroll-word-impl.css +370 -0
- package/dist/components/blocks/stats/Stats.d.ts +2 -1
- package/dist/components/blocks/stats/Stats.js +17 -14
- package/dist/components/blocks/stats/Stats.types.d.ts +8 -0
- package/dist/components/blocks/stats/stats-impl.css +31 -2
- package/dist/components/blocks/stats/use-wheel.d.ts +1 -1
- package/dist/components/blocks/stats/use-wheel.js +8 -4
- package/dist/components/blocks/stats-carousel/StatsCarousel.css +209 -0
- package/dist/components/blocks/stats-carousel/StatsCarousel.d.ts +20 -0
- package/dist/components/blocks/stats-carousel/StatsCarousel.js +48 -0
- package/dist/components/blocks/stats-carousel/StatsCarousel.types.d.ts +43 -0
- package/dist/components/blocks/stats-carousel/StatsCarousel.types.js +23 -0
- package/dist/components/blocks/stats-carousel/stats-carousel-impl.css +233 -0
- package/dist/components/blocks/sticky-cards/sticky-cards-impl.css +8 -0
- package/dist/components/blocks/testimonial-row/TestimonialRow.css +1 -1
- package/dist/components/blocks/testimonial-row/TestimonialRow.d.ts +2 -1
- package/dist/components/blocks/testimonial-row/TestimonialRow.js +16 -13
- package/dist/components/blocks/testimonial-row/TestimonialRow.types.d.ts +9 -1
- package/dist/components/blocks/testimonial-slider/TestimonialSlider.css +1 -1
- package/dist/components/blocks/testimonial-slider/TestimonialSlider.types.d.ts +1 -1
- package/dist/components/blocks/tiers/Tiers.types.d.ts +1 -1
- package/dist/components/core/background/Background.css +19 -0
- package/dist/components/core/background/Background.types.d.ts +2 -1
- package/dist/components/core/background/background-impl.css +47 -15
- package/dist/components/core/background/halftone.js +1 -1
- package/dist/components/core/button/Button.css +5 -5
- package/dist/components/core/button-icon/ButtonIcon.types.d.ts +1 -1
- package/dist/components/core/card-body/CardBody.css +5 -0
- package/dist/components/core/card-body/CardBody.types.d.ts +1 -1
- package/dist/components/core/document-link/DocumentLink.css +59 -0
- package/dist/components/core/document-link/DocumentLink.d.ts +19 -0
- package/dist/components/core/document-link/DocumentLink.js +21 -0
- package/dist/components/core/document-link/DocumentLink.types.d.ts +41 -0
- package/dist/components/core/document-link/DocumentLink.types.js +11 -0
- package/dist/components/core/document-link/document-link-impl.css +23 -0
- package/dist/components/core/illustration-card/IllustrationCard.css +7 -0
- package/dist/components/core/illustration-card/IllustrationCard.d.ts +5 -1
- package/dist/components/core/illustration-card/IllustrationCard.js +34 -8
- package/dist/components/core/illustration-card/IllustrationCard.types.d.ts +8 -1
- package/dist/components/core/illustration-card/IllustrationCard.types.js +1 -0
- package/dist/components/core/illustration-card/illustration-card-impl.css +117 -3
- package/dist/components/core/illustration-check/IllustrationCheck.css +25 -0
- package/dist/components/core/illustration-check/IllustrationCheck.d.ts +16 -0
- package/dist/components/core/illustration-check/IllustrationCheck.js +22 -0
- package/dist/components/core/illustration-check/IllustrationCheck.types.d.ts +25 -0
- package/dist/components/core/illustration-check/IllustrationCheck.types.js +9 -0
- package/dist/components/core/illustration-check/illustration-check-impl.css +76 -0
- package/dist/components/core/illustration-choice/IllustrationChoice.css +62 -0
- package/dist/components/core/illustration-choice/IllustrationChoice.d.ts +16 -0
- package/dist/components/core/illustration-choice/IllustrationChoice.js +31 -0
- package/dist/components/core/illustration-choice/IllustrationChoice.types.d.ts +25 -0
- package/dist/components/core/illustration-choice/IllustrationChoice.types.js +11 -0
- package/dist/components/core/illustration-choice/illustration-choice-impl.css +103 -0
- package/dist/components/core/illustration-code/IllustrationCode.css +25 -0
- package/dist/components/core/illustration-code/IllustrationCode.d.ts +12 -0
- package/dist/components/core/illustration-code/IllustrationCode.js +20 -0
- package/dist/components/core/illustration-code/IllustrationCode.types.d.ts +23 -0
- package/dist/components/core/illustration-code/IllustrationCode.types.js +8 -0
- package/dist/components/core/illustration-code/illustration-code-impl.css +42 -0
- package/dist/components/core/illustration-list/IllustrationList.css +19 -0
- package/dist/components/core/illustration-list/IllustrationList.d.ts +16 -0
- package/dist/components/core/illustration-list/IllustrationList.js +18 -0
- package/dist/components/core/illustration-list/IllustrationList.types.d.ts +15 -0
- package/dist/components/core/illustration-list/IllustrationList.types.js +6 -0
- package/dist/components/core/illustration-list/illustration-list-impl.css +52 -0
- package/dist/components/core/illustration-scene/IllustrationScene.css +6 -0
- package/dist/components/core/illustration-scene/IllustrationScene.d.ts +3 -2
- package/dist/components/core/illustration-scene/IllustrationScene.js +4 -3
- package/dist/components/core/illustration-scene/IllustrationScene.types.d.ts +5 -1
- package/dist/components/core/illustration-scene/IllustrationScene.types.js +2 -1
- package/dist/components/core/illustration-scene/illustration-scene-impl.css +65 -0
- package/dist/components/core/link/link-impl.css +5 -19
- package/dist/components/core/progress-bar/ProgressBar.css +101 -0
- package/dist/components/core/progress-bar/ProgressBar.d.ts +5 -0
- package/dist/components/core/progress-bar/ProgressBar.js +34 -0
- package/dist/components/core/progress-bar/ProgressBar.types.d.ts +52 -0
- package/dist/components/core/progress-bar/ProgressBar.types.js +12 -0
- package/dist/components/core/progress-bar/progress-bar-impl.css +45 -0
- package/dist/components/core/segmented-control/SegmentedControl.d.ts +1 -1
- package/dist/components/core/segmented-control/SegmentedControl.js +13 -5
- package/dist/components/core/segmented-control/SegmentedControl.types.d.ts +5 -1
- package/dist/components/core/segmented-control/segmented-control-impl.css +35 -0
- package/dist/components/core/status-dot/StatusDot.d.ts +1 -1
- package/dist/components/core/status-dot/StatusDot.js +7 -4
- package/dist/components/core/status-dot/StatusDot.types.d.ts +9 -1
- package/dist/components/core/status-dot/status-dot-impl.css +101 -0
- package/dist/components/core/typography/Typography.d.ts +3 -283
- package/dist/components/core/typography/Typography.js +9 -1
- package/dist/components/core/typography/Typography.types.d.ts +9 -15
- package/dist/components/core/typography/TypographyMotion.d.ts +28 -0
- package/dist/components/core/typography/TypographyMotion.js +43 -0
- package/dist/components/core/typography/typography-impl.css +106 -0
- package/dist/components/illustration-data.d.ts +15 -0
- package/dist/components/illustration-data.js +7 -0
- package/dist/components/index.d.ts +22 -1
- package/dist/components/index.js +20 -0
- package/dist/components/layout/grid/Grid.css +5 -0
- package/dist/components/layout/grid/Grid.types.d.ts +2 -1
- package/dist/components/scene-scroll-data.d.ts +35 -0
- package/dist/components/tiers-data.d.ts +3 -2
- package/dist/marketing.css +24 -6
- package/package.json +1 -1
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
<!-- GENERATED from document-link.contract.json. Do not edit. -->
|
|
2
|
+
|
|
3
|
+
# DocumentLink
|
|
4
|
+
|
|
5
|
+
One document a reader can open or save: its mark, its title, and an optional second link beside it.
|
|
6
|
+
|
|
7
|
+
## Why it is built this way
|
|
8
|
+
|
|
9
|
+
A legal or regulatory page lists documents by the dozen — key information documents, policies, a licence per country — and each is the same thing: a mark saying what kind of thing it is, the title a reader looks for, and a link to it, usually a PDF off the site. This draws that one thing the same way everywhere.
|
|
10
|
+
|
|
11
|
+
The whole of the mark and the title is the link. A second link — choosing the document's language, say — sits beside it as a sibling, never inside it, so there are two targets a reader can tell apart rather than one inside another. `chip` sets it on a surface of its own, for documents grouped in a list; `plain` leaves the mark and the title on the page, for a grid of many, as a grid of country flags is.
|
|
12
|
+
|
|
13
|
+
## Use when
|
|
14
|
+
|
|
15
|
+
- A document on a legal, regulatory or help page — a policy, a key information document, a licence, a form
|
|
16
|
+
- Many documents of one kind, listed or laid in a grid inside a Documents block
|
|
17
|
+
|
|
18
|
+
## Do not use
|
|
19
|
+
|
|
20
|
+
- One to four related pages or documents at the end of a section → `ResourceBanner`
|
|
21
|
+
- A link inside a sentence, or a page rather than a document → `Link`
|
|
22
|
+
- Navigation between pages of the site. A document chip says a file is behind it
|
|
23
|
+
- A document whose title alone does not say which it is. Two chips both reading "Key information document" are the same chip twice
|
|
24
|
+
|
|
25
|
+
## Anatomy
|
|
26
|
+
|
|
27
|
+
DocumentLink renders 5 elements. A token binding names the part it applies to.
|
|
28
|
+
|
|
29
|
+
- `root` — `<div>`, class `dds-documentlink`. The document's row: the link and, where there is one, the action beside it, pushed to the far end. Under `chip`, a surface of its own — color.bg.surface-card-raised edged with color.border.subtle, at radius.surface, padded by space.inset.sm and space.inset.md — so it stands out on any ground. Under `plain`, nothing but what it holds. Not itself interactive: it holds up to two links side by side, never one inside another. A chip sets its own ink, color.fg.default, on its own surface; a plain entry takes the ink of whatever it stands on, so it reads on a dark band as on the page.
|
|
30
|
+
- `link` — `<a>`, class `dds-documentlink__link`. The document: its mark and its title, one target. Opens in place, or in a new tab under `external`; saves the file under `download`. Its accessible name is the title, ending with `externalLabel` or `downloadLabel`, heard and never drawn, so a reader who cannot see the mark is told what happens. Underlined on hover; shows the focus ring when focused.
|
|
31
|
+
- `mark` — `<span>`, class `dds-documentlink__mark`. What kind of document it is, before its title: `mark`, or a file when there is none — FilePdfSolidIcon for a PDF, a country's flag from the flag icons for one country's licence. Decoration; the title names it. At icon.size.lg in a chip, icon.size.md plain.
|
|
32
|
+
- `title` — `<span>`, class `dds-documentlink__title`. The document's title, as a reader looks for it, at font.label.md in a chip and font.body.sm plain. Wraps rather than widening the row.
|
|
33
|
+
- `action` — `<div>`, class `dds-documentlink__action`. A second link beside the document — choosing its language — at the far end of the row, a sibling of the document's link and never inside it. Rendered only when `action` is set.
|
|
34
|
+
|
|
35
|
+
Apply these classes from the generated `documentLinkParts` constant rather than writing the strings by hand.
|
|
36
|
+
|
|
37
|
+
## Composition
|
|
38
|
+
|
|
39
|
+
- Can contain: `text`
|
|
40
|
+
|
|
41
|
+
## Props
|
|
42
|
+
|
|
43
|
+
### variant — `chip` | `plain` (default `chip`)
|
|
44
|
+
|
|
45
|
+
- `chip` — The default: the document on a surface of its own, for a list of documents grouped under headings
|
|
46
|
+
- `plain` — The mark and the title on the page itself, for a grid of many short entries — a licence per country, each behind its flag
|
|
47
|
+
|
|
48
|
+
Use when: How much the document stands out from the page around it
|
|
49
|
+
Never for: Mixing the two in one list. A list is one kind of thing; chips beside plain entries read as two
|
|
50
|
+
|
|
51
|
+
### href — `string` **Required.**
|
|
52
|
+
|
|
53
|
+
Use when: Always. Where the document is: a URL, usually a PDF
|
|
54
|
+
Never for: A page on the site. A page is a Link
|
|
55
|
+
|
|
56
|
+
### external — `boolean` (default `false`)
|
|
57
|
+
|
|
58
|
+
Use when: The document is hosted off the site — opens in a new tab, and its accessible name ends with `externalLabel`
|
|
59
|
+
Never for: A document on this site, which opens in place
|
|
60
|
+
|
|
61
|
+
### download — `boolean` (default `false`)
|
|
62
|
+
|
|
63
|
+
Use when: The link saves the file rather than opening it — its accessible name ends with `downloadLabel`
|
|
64
|
+
Never for: A document a browser opens to read, which most PDFs are. A file on another site. Browsers ignore `download` across origins and open the file instead, so the name would promise a download that does not happen; such a file is `external`
|
|
65
|
+
|
|
66
|
+
### mark — `node`
|
|
67
|
+
|
|
68
|
+
Accepts: Icon
|
|
69
|
+
Use when: What kind of document it is, as a glyph — FilePdfSolidIcon for a PDF, FileShieldSolidIcon for a policy, or a country's flag from `@deriv-com/dds-marketing/icons/flag` (`MaltaIcon`, `GermanyIcon`) for one country's licence. Left out, a plain file
|
|
70
|
+
Never for: Saying what the title does not. The mark is decoration and is never read out
|
|
71
|
+
|
|
72
|
+
### action — `node`
|
|
73
|
+
|
|
74
|
+
Accepts: Link
|
|
75
|
+
Use when: A second link beside the document — "Choose language" — drawn at the far end of the row as its own target
|
|
76
|
+
Never for: A second document. Each document is its own DocumentLink
|
|
77
|
+
|
|
78
|
+
### externalLabel — `string` (default `(opens in a new tab)`)
|
|
79
|
+
|
|
80
|
+
Use when: What an external document's accessible name ends with. Never drawn. Translate it with the page
|
|
81
|
+
Never for: Anything a sighted reader needs; it is never shown
|
|
82
|
+
|
|
83
|
+
### downloadLabel — `string` (default `(downloads a file)`)
|
|
84
|
+
|
|
85
|
+
Use when: What a download's accessible name ends with. Never drawn. Translate it with the page
|
|
86
|
+
Never for: Naming the file's format, which belongs in the title where it matters
|
|
87
|
+
|
|
88
|
+
Also accepts everything from `HTMLAttributes<HTMLDivElement>`.
|
|
89
|
+
|
|
90
|
+
## Accessibility
|
|
91
|
+
|
|
92
|
+
Guaranteed by the component. Write none of it by hand: the ids these attributes point at are generated per instance, so an attribute set from outside either says the same thing twice or points at nothing.
|
|
93
|
+
|
|
94
|
+
- `Tab` — Moves to the document's link, then to the action beside it where there is one
|
|
95
|
+
- the document's link and the action are two sibling links, never one inside the other
|
|
96
|
+
- an external document's accessible name ends with `externalLabel`, and a download's with `downloadLabel`, so a reader who cannot see the mark is told what happens
|
|
97
|
+
- the mark is decoration; the title names the document
|
|
98
|
+
|
|
99
|
+
## Rules
|
|
100
|
+
|
|
101
|
+
- **On a phone a section's actions stack and each fills the width, including when there is only one** — On a phone a page's actions stack, and each one fills the width. Not most of it, and not the width its label happens to need — the whole column.
|
|
102
|
+
|
|
103
|
+
Two side by side is what this replaces. On the narrowest screen each gets half a column minus the gap, which is rarely enough for a real label: the words wrap inside the pills, the two buttons come out different heights, and the pair reads as a broken row rather than as a choice. Stacked, each has the whole width and neither has to shorten its words to fit.
|
|
104
|
+
|
|
105
|
+
A single action fills too, and that is the part worth saying, because it is the one that looks unnecessary. A lone button has the room to sit at its natural width and still should not: a full-width control is the phone's convention for the thing the screen is asking you to do, and a pill hugging its label reads as one option among others that are not there. It also makes the target predictable — the whole width, wherever the thumb lands — which a centred pill does not.
|
|
106
|
+
|
|
107
|
+
Filling is the row's job rather than the button's. A button has no width of its own and is not given one; the row it sits in becomes a column and stretches its children, so nothing about the control changes and the same button is full width here and its own size on a desktop.
|
|
108
|
+
|
|
109
|
+
This is the phone's breakpoint, size.breakpoint.md, and not the wider one that decides whether a heading is centred. Those are different questions and they break at different widths: a heading stops being centred when the measure is the screen, while a button stops being full width much sooner than that — stretched across a tablet it is a long way from its own label, and a label centred in a metre of pill is harder to hit than one in a pill the size of the words.
|
|
110
|
+
|
|
111
|
+
What this is not about is every row of controls. A set of filter chips, a pagination strip, a toolbar, a link sitting after a sentence — none of these is the page asking for something, and stacking them to full width would turn a strip the eye skims into a list it has to read. The test is whether the row is the call to action the section was written for.
|
|
112
|
+
Guidance only — cannot be checked automatically.
|
|
113
|
+
- **Never nest one interactive element inside another** — Nested interactive elements produce ambiguous hit targets and an unreachable inner control for keyboard and screen-reader users. This is why the rule cannot live on any single component — it constrains Button, Link, CardButton and TextInput simultaneously.
|
|
114
|
+
Guidance only — cannot be checked automatically.
|
|
115
|
+
- **A page has at most one patterned band, between its hero and its closing call to action** — A patterned ground — the halftone, the aurora, the mesh, the grid or the rings — is what makes a band the one a reader stops at, and it only works by being the exception. So a page has at most one, placed between its hero and its closing call to action; the hero's and the call to action's own patterns are theirs and do not count, and the band never goes on either of them.
|
|
116
|
+
|
|
117
|
+
The pattern is the band's first layer, under its content and over nothing. A block that can carry one says so with its own `background` prop — FeatureCards, Stats, TestimonialRow and LogoRows — and draws it there; a section built by hand places a Background with nothing in it as its first child. Never wrap a block in a Background: the block paints its own ground over the pattern and hides it.
|
|
118
|
+
|
|
119
|
+
Only a band whose content is stacked can carry one. Every pattern rises from the band's foot, so the band needs a heading over what it introduces, centred, with the foot left open. A band whose content runs side by side — words beside a picture, a split, columns reaching the foot — puts the glow behind the picture or under the words; it stays on its flat ground.
|
|
120
|
+
Guidance only — cannot be checked automatically.
|
|
121
|
+
- **A section that paints a ground sets the ink to go with it** — A page sits on color.bg.page, and a section that separates itself from it takes one of three grounds. color.bg.subtle is the light one and needs nothing further — the page's own ink still reads on it. The other two are dark and do not: color.bg.brand-strong takes color.fg.on-brand-strong, and color.bg.brand takes color.fg.on-solid. Both are white, and both are written as the role rather than the white they resolve to. Set one of those backgrounds without its ink and the text inherits whatever the page was already using, which is near-black on a dark band — legible to nobody, and invisible to every check here, because each pair passes contrast on its own and nothing can tell whether a section used both.
|
|
122
|
+
|
|
123
|
+
color.bg.brand carries a second limit that is not about forgetting. Its ink measures 3.39:1, which clears the 3:1 a heading needs and misses the 4.5:1 running copy needs. A coral band may carry a headline and a call to action; a paragraph on one is text the reader has to work through at a ratio the waiver on that role does not cover — the waiver says so itself. A section with copy in it takes color.bg.brand-strong, which is near-black and carries white at full contrast.
|
|
124
|
+
|
|
125
|
+
color.bg.strong is not a section ground. It is the inverted fill for an action that has to outrank what surrounds it, and the components that paint it — Button and ButtonIcon in their inverse form — already set both halves in one rule, which is the pattern a hand-painted section has to copy.
|
|
126
|
+
Guidance only — cannot be checked automatically.
|
|
127
|
+
- **Every gap inside a section names the relationship it expresses, and the same relationship keeps its measure when it turns on its side** — A section's spacing is named by the relationship it expresses, not chosen by size. Every gap in a section has a role token, and reaching for a step off the generic scale because it happens to be the right number is how two sections written by two people stop lining up: the numbers agree today and drift the first time one of them is tuned.
|
|
128
|
+
|
|
129
|
+
The heading group is three steps, not one gap. An eyebrow sits nearer its title than the title sits to its description, and the actions sit further from the description than either — space.heading.eyebrow-title, space.heading.title-description, space.heading.description-actions, in that order. A single `gap` on the group cannot say this; it sets all three the same and the block reads as evenly spaced lines rather than as a mark, a name and a paragraph. The eyebrow has to identify itself for this to work, because a group that opens with a title must not give its description the eyebrow's tighter step.
|
|
130
|
+
|
|
131
|
+
The step between a title and its description follows the size of the title, which is why there are two of it. What a reader sees is not the gap but the gap plus the leading above it, and leading scales with the type: under a display title the leading is most of the space, under a card's title it is half as deep. One value for both makes a card look loose at the size that made a section look right. So space.heading.title-description is the display step and space.heading.title-description-compact is the step at a card's size, and the choice is made by how big the title is rather than by what kind of block it sits in.
|
|
132
|
+
|
|
133
|
+
Every one of those steps is smaller than the gap below the group, and that ordering is what holds the group together as one thing. space.heading.content is the step between a heading group and the content it introduces, and it is the widest measure inside a section: the one gap the eye reads as a change of subject rather than as a continuation.
|
|
134
|
+
|
|
135
|
+
That step is the same whether the content is under the heading or beside it. A split is the same relationship turned on its side — a heading group and the content it introduces — so the space between the two halves is space.heading.content, not a gutter. When the split collapses to one column on a phone the gap becomes vertical again, which is where it started, and nothing has to change for that to be right.
|
|
136
|
+
|
|
137
|
+
space.grid.gutter is between two things of the same kind. Two cards in a row are the same kind; the two halves of a split are not, which is why the gutter is the wrong measure there even when the number would have looked acceptable. The gutter runs on both axes, so a grid reads as an even field rather than as rows with a seam down them.
|
|
138
|
+
|
|
139
|
+
space.inset.card is the card's, not the page's. A row of cards padded differently is a row of different cards, and the fill is the only edge they have. A page composing a row does not get to choose it.
|
|
140
|
+
|
|
141
|
+
Column count is not a breakpoint decision. A row holds as many columns as fit before a column would be narrower than size.grid.column-min, and drops one when they would not. Written as a fixed count that collapses at a breakpoint, a four-up row keeps four columns at every width above the phone and sets its copy two or three words to a line through the whole of the tablet range — and on a narrow desktop, which no breakpoint sits on at all. The threshold is a property of the row rather than of a card: a card fills whatever cell it is given.
|
|
142
|
+
|
|
143
|
+
What this does not cover is the space above and below a section, which is space.section.default and space.section.compact, and the page's own side margin, which is space.inset.page. Those are the section's outside; everything here is its inside.
|
|
144
|
+
Guidance only — cannot be checked automatically.
|
|
145
|
+
- **A section's title is centred over stacked content, starts beside content in columns, and starts on a phone** — Two arrangements, and the title's alignment is decided by which one it is introducing rather than chosen per section.
|
|
146
|
+
|
|
147
|
+
Content stacked under the title — a row of cards, an accordion, a set of steps — takes a centred title. The heading group and the block below it share one axis, so a centred title is symmetric with the thing it names, and the eye drops from the middle of the words to the middle of the set. A title starting at the left over a centred or full-width block reads as belonging to the first column rather than to all of them.
|
|
148
|
+
|
|
149
|
+
Content beside the title — a split, a picture in the other half, anything laid out in columns — takes a title that starts where its content starts. The two share a left edge, and that edge is what says they are one thing read across rather than two stacked. Centring the title there breaks the only alignment the reader has to hold the halves together, and it drifts further from its content the wider the page gets.
|
|
150
|
+
|
|
151
|
+
The heading group is what carries this, not the heading alone. An eyebrow, a title and a description are read as one block and align together; aligning the title without them leaves a centred heading over start-aligned copy, which reads as a mistake rather than as a choice.
|
|
152
|
+
|
|
153
|
+
Centred means all of it, not just the words. A badge, a row of actions, a picture — these are flex children, and a flex child is placed by align-items rather than by text-align, so a block that only sets the text leaves everything that is not text at the start. A hero is the case that shows it: its title and copy centred while its badge and its buttons did not.
|
|
154
|
+
|
|
155
|
+
A capped block centres itself as well as its words. A heading group takes size.heading-group.max, and a cap that is not centred leaves the measure at the start of the column with the words centred inside it — composed, and a long way left of the middle it appears to be in.
|
|
156
|
+
|
|
157
|
+
Both arrangements go to the start on a phone. A centred block reverts below the breakpoint, and the reason is the measure: on a phone the measure is the screen, so a centred title wraps to three or four ragged lines and the eye loses the left edge it was tracking — the same symmetry that reads as composure on a desktop is what makes it hard to scan on a phone. Centring there has to be asked for twice, and a section title is not one of the things that asks: it is centred because there is room for it, and on a phone there is not. Going back to the start means all of it too, and a capped block is the one that hides a leftover: its words go to the start while its measure stays in the middle of the column, which reads as a title still centred over a badge and buttons that are not — the box in the middle and the line inside it at the edge.
|
|
158
|
+
|
|
159
|
+
A hero is a section like any other: its badge, title, copy and actions are one stacked block, so it is centred on a desktop and starts on a phone with everything else.
|
|
160
|
+
|
|
161
|
+
What this is not about is a page whose body is a form or a document. A title over a sign-up form or a guide is not introducing a set of content — it is the first line of the thing itself, and it keeps the alignment the body has, which for running text is the start. The distinction is whether the block below is content the title names or content the title is part of.
|
|
162
|
+
Guidance only — cannot be checked automatically.
|
|
163
|
+
- **Anything a pointer has to hit is at least 24px in both directions** — A control sized by its contents is as big as its contents, and a glyph is chosen for how it reads rather than for how easily it is hit. An icon-only button with no padding is a 16px target — smaller than the pad of a finger, and smaller than the tremor of a hand using a mouse.
|
|
164
|
+
|
|
165
|
+
WCAG 2.2 asks for 24 by 24 CSS pixels at AA. The exceptions are narrower than they look: inline targets inside a sentence are exempt, and so is a small target with 24px of clear space around it — but a clear button sits against the field it empties, and a field is itself a target, so the spacing exemption does not apply to the case that keeps arising.
|
|
166
|
+
|
|
167
|
+
The target and the mark are separate decisions, and conflating them is what produces both faults. Growing the glyph to 24px makes it shout; leaving the button at 16px makes it hard to hit. So the glyph keeps the size that reads correctly beside its text, and the box around it declares a minimum of its own — which is what size.target.min is for.
|
|
168
|
+
|
|
169
|
+
Declared rather than emergent. Padding plus contents does clear 24px in several components today, and it is the weaker statement: it is a size nobody wrote down, so it moves when the type scale or the glyph does, and nothing says it was meant to be a target at all.
|
|
170
|
+
Guidance only — cannot be checked automatically.
|
|
171
|
+
- **A component is written along the reading axis, not along the page's left and right** — Every measure, inset and placement in this package names an axis rather than a side: inline-size and block-size, padding-inline and padding-block, inset-inline-start and inset-block-end, margin-inline: auto, text-align: start. Written that way a component follows whichever direction the page is read in, and a band whose claim ranges to the leading edge with its subject on the trailing one is the same composition in Arabic as in English, mirrored, with nothing restated. Written as left and right it is the same pixels in both, which is a layout nobody designed for the second language.
|
|
172
|
+
|
|
173
|
+
The enum values follow the same rule and for the same reason. A prop that names where a picture sits takes start and end, never left and right — FeatureSplit, FeatureBullets and FeatureScroll all declare mediaPosition that way, and the flex directions they generate flip on their own because row already means the reading order. A value called left would have to be re-read as right by every author working in a mirrored page, which is a translation this system should be doing rather than asking for.
|
|
174
|
+
|
|
175
|
+
The guidance a contract carries is part of the component, so it follows too. Describing a claim as ranging left is describing one of the two languages, and it was written that way here for a while: three of the opening bands said so in their own intent. A reader in a mirrored page meets that sentence and has to decide whether the component is wrong or the sentence is, and neither answer is one documentation should force.
|
|
176
|
+
|
|
177
|
+
Two things genuinely have no logical form and are not covered by this. A CSS gradient takes a physical direction — there is no to inline-end — so a pattern that must mirror has to be stated twice under a direction query, and one that is periodic and centred, like PageHeader's rule grid, does not need to. A glyph that points the way onward is the other: an arrow is a picture of a direction, and mirroring it belongs to the icon set rather than to the component holding it.
|
|
178
|
+
Guidance only — cannot be checked automatically.
|
|
179
|
+
|
|
180
|
+
## Anti-examples
|
|
181
|
+
|
|
182
|
+
❌ DocumentLink for: One to four related pages or documents at the end of a section
|
|
183
|
+
A short stack of where to read more is ResourceBanner's job; this is one document among many
|
|
184
|
+
→ use `ResourceBanner` instead.
|
|
185
|
+
|
|
186
|
+
❌ DocumentLink for: A link inside a sentence, or a page rather than a document
|
|
187
|
+
A document has a mark and a title a reader scans for; a link to a page is a Link
|
|
188
|
+
→ use `Link` instead.
|
|
189
|
+
|
|
190
|
+
## Example
|
|
191
|
+
|
|
192
|
+
```tsx
|
|
193
|
+
import { DocumentLink, Icon } from '@deriv-com/dds-marketing'
|
|
194
|
+
import { FileShieldSolidIcon } from '@deriv-com/dds-marketing/icons'
|
|
195
|
+
|
|
196
|
+
<DocumentLink href="https://example.com/key-information-document.pdf" external mark={<Icon size="xs"><FileShieldSolidIcon /></Icon>}>Key information document: CFDs on forex</DocumentLink>
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## In use
|
|
200
|
+
|
|
201
|
+
### Chip and plain
|
|
202
|
+
|
|
203
|
+
A chip for a document in a grouped list; plain for one entry in a grid of many, a licence behind its country's flag.
|
|
204
|
+
|
|
205
|
+
```tsx
|
|
206
|
+
import { DocumentLink, Icon } from '@deriv-com/dds-marketing'
|
|
207
|
+
import { FileShieldSolidIcon } from '@deriv-com/dds-marketing/icons'
|
|
208
|
+
|
|
209
|
+
// chip
|
|
210
|
+
<DocumentLink variant="chip" href="https://example.com/kid.pdf" external mark={<Icon size="xs"><FileShieldSolidIcon /></Icon>}>Key information document: CFDs on forex</DocumentLink>
|
|
211
|
+
|
|
212
|
+
// plain
|
|
213
|
+
<DocumentLink variant="plain" href="https://example.com/malta.pdf" external mark={<Icon size="xs"><FileShieldSolidIcon /></Icon>}>Malta</DocumentLink>
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### With a second link
|
|
217
|
+
|
|
218
|
+
A language choice beside the document, its own target at the far end of the row.
|
|
219
|
+
|
|
220
|
+
```tsx
|
|
221
|
+
import { DocumentLink, Icon, Link } from '@deriv-com/dds-marketing'
|
|
222
|
+
import { FileShieldSolidIcon } from '@deriv-com/dds-marketing/icons'
|
|
223
|
+
|
|
224
|
+
// action
|
|
225
|
+
<DocumentLink href="https://example.com/terms.pdf" external mark={<Icon size="xs"><FileShieldSolidIcon /></Icon>} action={<Link href="#" tone="inherit">Choose language</Link>}>Terms and conditions</DocumentLink>
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### A file to save
|
|
229
|
+
|
|
230
|
+
`download` saves the file rather than opening it, and the link's name says so.
|
|
231
|
+
|
|
232
|
+
```tsx
|
|
233
|
+
import { DocumentLink } from '@deriv-com/dds-marketing'
|
|
234
|
+
|
|
235
|
+
// download
|
|
236
|
+
<DocumentLink href="https://example.com/form.pdf" download>Account closure form</DocumentLink>
|
|
237
|
+
```
|
|
@@ -0,0 +1,268 @@
|
|
|
1
|
+
<!-- GENERATED from documents.contract.json. Do not edit. -->
|
|
2
|
+
|
|
3
|
+
# Documents
|
|
4
|
+
|
|
5
|
+
A section of documents to open or save — grouped under headings that expand, or laid in a grid beside its heading.
|
|
6
|
+
|
|
7
|
+
## Why it is built this way
|
|
8
|
+
|
|
9
|
+
Legal, regulatory and help pages publish documents by the dozen: key information documents by product, policies, a licence for each country the company works in. This is the section they sit in, in one of two shapes — the reference design's DocumentChips and CountryLinkGrid, one block because they are one job.
|
|
10
|
+
|
|
11
|
+
`groups` lays the documents under headings that expand, one group open at a time, each document a DocumentLink chip, two to a row from the fold. `grid` sets the heading beside a grid of short entries — a country's flag and its name, each a link to that country's document — two to four across as the width allows. Both are built from children, so a page writes the groups and the documents it has, and flags are the package's own flag icons rather than images fetched from elsewhere.
|
|
12
|
+
|
|
13
|
+
## Use when
|
|
14
|
+
|
|
15
|
+
- A legal or regulatory page's documents — key information documents grouped by product, policies, terms
|
|
16
|
+
- A document per country, region or entity, each behind its flag or mark — `layout="grid"`
|
|
17
|
+
- Any list of more documents than a ResourceBanner's four
|
|
18
|
+
|
|
19
|
+
## Do not use
|
|
20
|
+
|
|
21
|
+
- One to four documents or pages at the end of a section → `ResourceBanner`
|
|
22
|
+
- Questions and their answers → `FaqAccordion`
|
|
23
|
+
- Documents the reader must see before acting — a risk warning on the page it governs. A folded group is one most readers never open
|
|
24
|
+
- Navigation between the site's pages. Each entry is a document; a page is a Link
|
|
25
|
+
- Mixing the two shapes in one section. Groups of chips beside a grid of flags is two sections
|
|
26
|
+
|
|
27
|
+
## Anatomy
|
|
28
|
+
|
|
29
|
+
Documents renders 8 elements. A token binding names the part it applies to.
|
|
30
|
+
|
|
31
|
+
- `root` — `<section>`, class `dds-documents`. The section, a region named by its heading, on the ground `ground` paints with the ink that goes with it.
|
|
32
|
+
- `inner` — `<div>`, class `dds-documents__inner`. The measure and the gutter, the same column every band holds its content in, and the step from the heading to the documents: space.heading.content.
|
|
33
|
+
- `title` — `<h2>`, class `dds-documents__title`. What the documents are — "Regulatory documents", "Licences by country". `h2` because a section sits under the page's own heading, and each group heading below it is an `h3` — Accordion's own default level. Starts on a phone, centred from the fold under `groups`.
|
|
34
|
+
- `header` — `<div>`, class `dds-documents__header`. The heading and the line under it. Over the documents under `groups`; beside the grid from 62rem under `grid`, and over it below.
|
|
35
|
+
- `description` — `<p>`, class `dds-documents__description`. The line under the heading, at font.body.md. Rendered only when `description` is set.
|
|
36
|
+
- `body` — `<div>`, class `dds-documents__body`. The documents: an Accordion of the groups under `groups`, the list of entries under `grid`.
|
|
37
|
+
- `list` — `<ul>`, class `dds-documents__list`. Under `grid`, the entries as a list: two across on a phone, three from 35rem, four from 48rem; from 62rem, where the grid shares the width with the heading, two, and three again from 75rem — so a country's name stays on one line. Rendered only when `layout` is set.
|
|
38
|
+
- `item` — `<li>`, class `dds-documents__item`. One entry of the grid, holding one DocumentLink.
|
|
39
|
+
|
|
40
|
+
Apply these classes from the generated `documentsParts` constant rather than writing the strings by hand.
|
|
41
|
+
|
|
42
|
+
## Composition
|
|
43
|
+
|
|
44
|
+
- Can contain: `AccordionItem`, `DocumentLink`
|
|
45
|
+
- Never contains: `Accordion`, `FaqAccordion`, `Documents`, `LandingHero`, `ProductHero`, `PageHeader`, `Footer`, `Navbar` — in children or in any prop that takes a node
|
|
46
|
+
- Holds at least 1
|
|
47
|
+
|
|
48
|
+
## Props
|
|
49
|
+
|
|
50
|
+
### ground — `page` | `subtle` | `strong` (default `page`)
|
|
51
|
+
|
|
52
|
+
- `page` — The default, and the page's own white. A section that has nothing to separate itself from what is above it — most of them — and the ground a reader is already on
|
|
53
|
+
- `subtle` — A quiet step off the page, for a band that wants to read as its own section without changing the page's voice — the reference design's slate FAQ. Painted as the band's tint laid over the page's own ground, so it is the same grey whatever is behind the section.
|
|
54
|
+
- `strong` — `color.bg.brand-strong`, the dark band. It stops the page rather than dividing it, so it is for a section a reader should arrive at — and one per page is usually one more than enough. The documents turn round with it: white group headings, a muted chevron, rules in the band's own veil and a focus ring drawn for the dark, fixed like the band
|
|
55
|
+
|
|
56
|
+
Use when: Which of the page's three grounds this section paints. A marketing page is white, and a band that wants to be seen as a band takes one of the other two — so this is how a page builds its rhythm: white, white, grey, white, dark. Two in a row is a deliberate pair rather than an accident, and the section above knows nothing about the one below it, so the page is the only thing that can decide.
|
|
57
|
+
|
|
58
|
+
The ink follows the ground and is not a second decision: a dark band carries white type because this sets both halves in one value, which is what the painted-ground-carries-its-ink rule exists to stop a page getting wrong.
|
|
59
|
+
Never for: Marking importance. Every section on a page painted a ground is a page with no emphasis left.
|
|
60
|
+
|
|
61
|
+
### layout — `groups` | `grid` (default `groups`)
|
|
62
|
+
|
|
63
|
+
- `groups` — The default: the documents under headings that expand, one group open at a time — AccordionItem children, each holding DocumentLink chips, two to a row from the fold. The reference design's DocumentChips
|
|
64
|
+
- `grid` — Many short entries of one kind — a document per country, each behind its flag — DocumentLink children with `variant="plain"`, in a grid beside the heading from 62rem and under it below. The reference design's CountryLinkGrid
|
|
65
|
+
|
|
66
|
+
Use when: How the documents are laid out: grouped under headings, or as one grid of entries
|
|
67
|
+
Never for: Choosing by how many documents there are alone. Groups are for documents of different kinds; a grid is for many of one kind
|
|
68
|
+
|
|
69
|
+
### title — `string` **Required.**
|
|
70
|
+
|
|
71
|
+
Use when: Always. What the documents are, in a few words — "Regulatory documents", "Licences by country". It names the section
|
|
72
|
+
Never for: A sentence. The line under it says more
|
|
73
|
+
|
|
74
|
+
### description — `string`
|
|
75
|
+
|
|
76
|
+
Use when: A line under the heading saying what the documents are for or who they apply to
|
|
77
|
+
Never for: Instructions a reader must follow; they belong on the page the documents govern
|
|
78
|
+
|
|
79
|
+
## Accessibility
|
|
80
|
+
|
|
81
|
+
Guaranteed by the component. Write none of it by hand: the ids these attributes point at are generated per instance, so an attribute set from outside either says the same thing twice or points at nothing.
|
|
82
|
+
|
|
83
|
+
- Announced as: `region`
|
|
84
|
+
- `Tab` — Moves through the group headings, then into an open group's documents, each document's link and its action in turn
|
|
85
|
+
- the section is a region named by its heading
|
|
86
|
+
- under `groups`, each group heading is a button that says whether it is open, and one group is open at a time
|
|
87
|
+
- under `grid`, the entries are a list, so a reader hears how many there are
|
|
88
|
+
|
|
89
|
+
## Rules
|
|
90
|
+
|
|
91
|
+
- **On a phone a section's actions stack and each fills the width, including when there is only one** — On a phone a page's actions stack, and each one fills the width. Not most of it, and not the width its label happens to need — the whole column.
|
|
92
|
+
|
|
93
|
+
Two side by side is what this replaces. On the narrowest screen each gets half a column minus the gap, which is rarely enough for a real label: the words wrap inside the pills, the two buttons come out different heights, and the pair reads as a broken row rather than as a choice. Stacked, each has the whole width and neither has to shorten its words to fit.
|
|
94
|
+
|
|
95
|
+
A single action fills too, and that is the part worth saying, because it is the one that looks unnecessary. A lone button has the room to sit at its natural width and still should not: a full-width control is the phone's convention for the thing the screen is asking you to do, and a pill hugging its label reads as one option among others that are not there. It also makes the target predictable — the whole width, wherever the thumb lands — which a centred pill does not.
|
|
96
|
+
|
|
97
|
+
Filling is the row's job rather than the button's. A button has no width of its own and is not given one; the row it sits in becomes a column and stretches its children, so nothing about the control changes and the same button is full width here and its own size on a desktop.
|
|
98
|
+
|
|
99
|
+
This is the phone's breakpoint, size.breakpoint.md, and not the wider one that decides whether a heading is centred. Those are different questions and they break at different widths: a heading stops being centred when the measure is the screen, while a button stops being full width much sooner than that — stretched across a tablet it is a long way from its own label, and a label centred in a metre of pill is harder to hit than one in a pill the size of the words.
|
|
100
|
+
|
|
101
|
+
What this is not about is every row of controls. A set of filter chips, a pagination strip, a toolbar, a link sitting after a sentence — none of these is the page asking for something, and stacking them to full width would turn a strip the eye skims into a list it has to read. The test is whether the row is the call to action the section was written for.
|
|
102
|
+
Guidance only — cannot be checked automatically.
|
|
103
|
+
- **Never nest one interactive element inside another** — Nested interactive elements produce ambiguous hit targets and an unreachable inner control for keyboard and screen-reader users. This is why the rule cannot live on any single component — it constrains Button, Link, CardButton and TextInput simultaneously.
|
|
104
|
+
Guidance only — cannot be checked automatically.
|
|
105
|
+
- **A page has at most one patterned band, between its hero and its closing call to action** — A patterned ground — the halftone, the aurora, the mesh, the grid or the rings — is what makes a band the one a reader stops at, and it only works by being the exception. So a page has at most one, placed between its hero and its closing call to action; the hero's and the call to action's own patterns are theirs and do not count, and the band never goes on either of them.
|
|
106
|
+
|
|
107
|
+
The pattern is the band's first layer, under its content and over nothing. A block that can carry one says so with its own `background` prop — FeatureCards, Stats, TestimonialRow and LogoRows — and draws it there; a section built by hand places a Background with nothing in it as its first child. Never wrap a block in a Background: the block paints its own ground over the pattern and hides it.
|
|
108
|
+
|
|
109
|
+
Only a band whose content is stacked can carry one. Every pattern rises from the band's foot, so the band needs a heading over what it introduces, centred, with the foot left open. A band whose content runs side by side — words beside a picture, a split, columns reaching the foot — puts the glow behind the picture or under the words; it stays on its flat ground.
|
|
110
|
+
Guidance only — cannot be checked automatically.
|
|
111
|
+
- **A section that paints a ground sets the ink to go with it** — A page sits on color.bg.page, and a section that separates itself from it takes one of three grounds. color.bg.subtle is the light one and needs nothing further — the page's own ink still reads on it. The other two are dark and do not: color.bg.brand-strong takes color.fg.on-brand-strong, and color.bg.brand takes color.fg.on-solid. Both are white, and both are written as the role rather than the white they resolve to. Set one of those backgrounds without its ink and the text inherits whatever the page was already using, which is near-black on a dark band — legible to nobody, and invisible to every check here, because each pair passes contrast on its own and nothing can tell whether a section used both.
|
|
112
|
+
|
|
113
|
+
color.bg.brand carries a second limit that is not about forgetting. Its ink measures 3.39:1, which clears the 3:1 a heading needs and misses the 4.5:1 running copy needs. A coral band may carry a headline and a call to action; a paragraph on one is text the reader has to work through at a ratio the waiver on that role does not cover — the waiver says so itself. A section with copy in it takes color.bg.brand-strong, which is near-black and carries white at full contrast.
|
|
114
|
+
|
|
115
|
+
color.bg.strong is not a section ground. It is the inverted fill for an action that has to outrank what surrounds it, and the components that paint it — Button and ButtonIcon in their inverse form — already set both halves in one rule, which is the pattern a hand-painted section has to copy.
|
|
116
|
+
Guidance only — cannot be checked automatically.
|
|
117
|
+
- **Every gap inside a section names the relationship it expresses, and the same relationship keeps its measure when it turns on its side** — A section's spacing is named by the relationship it expresses, not chosen by size. Every gap in a section has a role token, and reaching for a step off the generic scale because it happens to be the right number is how two sections written by two people stop lining up: the numbers agree today and drift the first time one of them is tuned.
|
|
118
|
+
|
|
119
|
+
The heading group is three steps, not one gap. An eyebrow sits nearer its title than the title sits to its description, and the actions sit further from the description than either — space.heading.eyebrow-title, space.heading.title-description, space.heading.description-actions, in that order. A single `gap` on the group cannot say this; it sets all three the same and the block reads as evenly spaced lines rather than as a mark, a name and a paragraph. The eyebrow has to identify itself for this to work, because a group that opens with a title must not give its description the eyebrow's tighter step.
|
|
120
|
+
|
|
121
|
+
The step between a title and its description follows the size of the title, which is why there are two of it. What a reader sees is not the gap but the gap plus the leading above it, and leading scales with the type: under a display title the leading is most of the space, under a card's title it is half as deep. One value for both makes a card look loose at the size that made a section look right. So space.heading.title-description is the display step and space.heading.title-description-compact is the step at a card's size, and the choice is made by how big the title is rather than by what kind of block it sits in.
|
|
122
|
+
|
|
123
|
+
Every one of those steps is smaller than the gap below the group, and that ordering is what holds the group together as one thing. space.heading.content is the step between a heading group and the content it introduces, and it is the widest measure inside a section: the one gap the eye reads as a change of subject rather than as a continuation.
|
|
124
|
+
|
|
125
|
+
That step is the same whether the content is under the heading or beside it. A split is the same relationship turned on its side — a heading group and the content it introduces — so the space between the two halves is space.heading.content, not a gutter. When the split collapses to one column on a phone the gap becomes vertical again, which is where it started, and nothing has to change for that to be right.
|
|
126
|
+
|
|
127
|
+
space.grid.gutter is between two things of the same kind. Two cards in a row are the same kind; the two halves of a split are not, which is why the gutter is the wrong measure there even when the number would have looked acceptable. The gutter runs on both axes, so a grid reads as an even field rather than as rows with a seam down them.
|
|
128
|
+
|
|
129
|
+
space.inset.card is the card's, not the page's. A row of cards padded differently is a row of different cards, and the fill is the only edge they have. A page composing a row does not get to choose it.
|
|
130
|
+
|
|
131
|
+
Column count is not a breakpoint decision. A row holds as many columns as fit before a column would be narrower than size.grid.column-min, and drops one when they would not. Written as a fixed count that collapses at a breakpoint, a four-up row keeps four columns at every width above the phone and sets its copy two or three words to a line through the whole of the tablet range — and on a narrow desktop, which no breakpoint sits on at all. The threshold is a property of the row rather than of a card: a card fills whatever cell it is given.
|
|
132
|
+
|
|
133
|
+
What this does not cover is the space above and below a section, which is space.section.default and space.section.compact, and the page's own side margin, which is space.inset.page. Those are the section's outside; everything here is its inside.
|
|
134
|
+
Guidance only — cannot be checked automatically.
|
|
135
|
+
- **A section's title is centred over stacked content, starts beside content in columns, and starts on a phone** — Two arrangements, and the title's alignment is decided by which one it is introducing rather than chosen per section.
|
|
136
|
+
|
|
137
|
+
Content stacked under the title — a row of cards, an accordion, a set of steps — takes a centred title. The heading group and the block below it share one axis, so a centred title is symmetric with the thing it names, and the eye drops from the middle of the words to the middle of the set. A title starting at the left over a centred or full-width block reads as belonging to the first column rather than to all of them.
|
|
138
|
+
|
|
139
|
+
Content beside the title — a split, a picture in the other half, anything laid out in columns — takes a title that starts where its content starts. The two share a left edge, and that edge is what says they are one thing read across rather than two stacked. Centring the title there breaks the only alignment the reader has to hold the halves together, and it drifts further from its content the wider the page gets.
|
|
140
|
+
|
|
141
|
+
The heading group is what carries this, not the heading alone. An eyebrow, a title and a description are read as one block and align together; aligning the title without them leaves a centred heading over start-aligned copy, which reads as a mistake rather than as a choice.
|
|
142
|
+
|
|
143
|
+
Centred means all of it, not just the words. A badge, a row of actions, a picture — these are flex children, and a flex child is placed by align-items rather than by text-align, so a block that only sets the text leaves everything that is not text at the start. A hero is the case that shows it: its title and copy centred while its badge and its buttons did not.
|
|
144
|
+
|
|
145
|
+
A capped block centres itself as well as its words. A heading group takes size.heading-group.max, and a cap that is not centred leaves the measure at the start of the column with the words centred inside it — composed, and a long way left of the middle it appears to be in.
|
|
146
|
+
|
|
147
|
+
Both arrangements go to the start on a phone. A centred block reverts below the breakpoint, and the reason is the measure: on a phone the measure is the screen, so a centred title wraps to three or four ragged lines and the eye loses the left edge it was tracking — the same symmetry that reads as composure on a desktop is what makes it hard to scan on a phone. Centring there has to be asked for twice, and a section title is not one of the things that asks: it is centred because there is room for it, and on a phone there is not. Going back to the start means all of it too, and a capped block is the one that hides a leftover: its words go to the start while its measure stays in the middle of the column, which reads as a title still centred over a badge and buttons that are not — the box in the middle and the line inside it at the edge.
|
|
148
|
+
|
|
149
|
+
A hero is a section like any other: its badge, title, copy and actions are one stacked block, so it is centred on a desktop and starts on a phone with everything else.
|
|
150
|
+
|
|
151
|
+
What this is not about is a page whose body is a form or a document. A title over a sign-up form or a guide is not introducing a set of content — it is the first line of the thing itself, and it keeps the alignment the body has, which for running text is the start. The distinction is whether the block below is content the title names or content the title is part of.
|
|
152
|
+
Guidance only — cannot be checked automatically.
|
|
153
|
+
- **Anything a pointer has to hit is at least 24px in both directions** — A control sized by its contents is as big as its contents, and a glyph is chosen for how it reads rather than for how easily it is hit. An icon-only button with no padding is a 16px target — smaller than the pad of a finger, and smaller than the tremor of a hand using a mouse.
|
|
154
|
+
|
|
155
|
+
WCAG 2.2 asks for 24 by 24 CSS pixels at AA. The exceptions are narrower than they look: inline targets inside a sentence are exempt, and so is a small target with 24px of clear space around it — but a clear button sits against the field it empties, and a field is itself a target, so the spacing exemption does not apply to the case that keeps arising.
|
|
156
|
+
|
|
157
|
+
The target and the mark are separate decisions, and conflating them is what produces both faults. Growing the glyph to 24px makes it shout; leaving the button at 16px makes it hard to hit. So the glyph keeps the size that reads correctly beside its text, and the box around it declares a minimum of its own — which is what size.target.min is for.
|
|
158
|
+
|
|
159
|
+
Declared rather than emergent. Padding plus contents does clear 24px in several components today, and it is the weaker statement: it is a size nobody wrote down, so it moves when the type scale or the glyph does, and nothing says it was meant to be a target at all.
|
|
160
|
+
Guidance only — cannot be checked automatically.
|
|
161
|
+
- **A component is written along the reading axis, not along the page's left and right** — Every measure, inset and placement in this package names an axis rather than a side: inline-size and block-size, padding-inline and padding-block, inset-inline-start and inset-block-end, margin-inline: auto, text-align: start. Written that way a component follows whichever direction the page is read in, and a band whose claim ranges to the leading edge with its subject on the trailing one is the same composition in Arabic as in English, mirrored, with nothing restated. Written as left and right it is the same pixels in both, which is a layout nobody designed for the second language.
|
|
162
|
+
|
|
163
|
+
The enum values follow the same rule and for the same reason. A prop that names where a picture sits takes start and end, never left and right — FeatureSplit, FeatureBullets and FeatureScroll all declare mediaPosition that way, and the flex directions they generate flip on their own because row already means the reading order. A value called left would have to be re-read as right by every author working in a mirrored page, which is a translation this system should be doing rather than asking for.
|
|
164
|
+
|
|
165
|
+
The guidance a contract carries is part of the component, so it follows too. Describing a claim as ranging left is describing one of the two languages, and it was written that way here for a while: three of the opening bands said so in their own intent. A reader in a mirrored page meets that sentence and has to decide whether the component is wrong or the sentence is, and neither answer is one documentation should force.
|
|
166
|
+
|
|
167
|
+
Two things genuinely have no logical form and are not covered by this. A CSS gradient takes a physical direction — there is no to inline-end — so a pattern that must mirror has to be stated twice under a direction query, and one that is periodic and centred, like PageHeader's rule grid, does not need to. A glyph that points the way onward is the other: an arrow is a picture of a direction, and mirroring it belongs to the icon set rather than to the component holding it.
|
|
168
|
+
Guidance only — cannot be checked automatically.
|
|
169
|
+
|
|
170
|
+
## Anti-examples
|
|
171
|
+
|
|
172
|
+
❌ Documents for: One to four documents or pages at the end of a section
|
|
173
|
+
A short stack of where to read more is ResourceBanner's job; this is a library of documents
|
|
174
|
+
→ use `ResourceBanner` instead.
|
|
175
|
+
|
|
176
|
+
❌ Documents for: Questions and their answers
|
|
177
|
+
FaqAccordion is questions a reader asks; these headings are groups of files
|
|
178
|
+
→ use `FaqAccordion` instead.
|
|
179
|
+
|
|
180
|
+
## Example
|
|
181
|
+
|
|
182
|
+
```tsx
|
|
183
|
+
import { Documents, AccordionItem, DocumentLink, Link } from '@deriv-com/dds-marketing'
|
|
184
|
+
import { FileShieldSolidIcon } from '@deriv-com/dds-marketing/icons'
|
|
185
|
+
|
|
186
|
+
<Documents title="Regulatory documents" description="Our key information documents and policies, by product.">
|
|
187
|
+
<AccordionItem title="Key information documents" onExpandedChange={(expanded) => { /* your handler */ }}>
|
|
188
|
+
<DocumentLink href="/documents/kid-forex.pdf" mark={<FileShieldSolidIcon />} action={<Link href="/documents/languages" tone="inherit">Choose language</Link>}>CFDs on forex</DocumentLink>
|
|
189
|
+
<DocumentLink href="/documents/kid-stocks.pdf" mark={<FileShieldSolidIcon />} action={<Link href="/documents/languages" tone="inherit">Choose language</Link>}>CFDs on stocks</DocumentLink>
|
|
190
|
+
<DocumentLink href="/documents/kid-commodities.pdf" mark={<FileShieldSolidIcon />}>CFDs on commodities</DocumentLink>
|
|
191
|
+
</AccordionItem>
|
|
192
|
+
<AccordionItem title="Policies" onExpandedChange={(expanded) => { /* your handler */ }}>
|
|
193
|
+
<DocumentLink href="/documents/execution.pdf" mark={<FileShieldSolidIcon />}>Order execution policy</DocumentLink>
|
|
194
|
+
<DocumentLink href="/documents/conflicts.pdf" mark={<FileShieldSolidIcon />}>Conflicts of interest policy</DocumentLink>
|
|
195
|
+
</AccordionItem>
|
|
196
|
+
</Documents>
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## In use
|
|
200
|
+
|
|
201
|
+
Most rows below hold the same set, written once here:
|
|
202
|
+
|
|
203
|
+
```tsx
|
|
204
|
+
import { AccordionItem, DocumentLink, Link } from '@deriv-com/dds-marketing'
|
|
205
|
+
|
|
206
|
+
const accordionitems = (
|
|
207
|
+
<>
|
|
208
|
+
<AccordionItem title="Key information documents">
|
|
209
|
+
<DocumentLink href="/documents/kid-forex.pdf" mark={<FileShieldSolidIcon />} action={<Link href="/documents/languages" tone="inherit">Choose language</Link>}>CFDs on forex</DocumentLink>
|
|
210
|
+
<DocumentLink href="/documents/kid-stocks.pdf" mark={<FileShieldSolidIcon />} action={<Link href="/documents/languages" tone="inherit">Choose language</Link>}>CFDs on stocks</DocumentLink>
|
|
211
|
+
<DocumentLink href="/documents/kid-commodities.pdf" mark={<FileShieldSolidIcon />}>CFDs on commodities</DocumentLink>
|
|
212
|
+
</AccordionItem>
|
|
213
|
+
<AccordionItem title="Policies">
|
|
214
|
+
<DocumentLink href="/documents/execution.pdf" mark={<FileShieldSolidIcon />}>Order execution policy</DocumentLink>
|
|
215
|
+
<DocumentLink href="/documents/conflicts.pdf" mark={<FileShieldSolidIcon />}>Conflicts of interest policy</DocumentLink>
|
|
216
|
+
</AccordionItem>
|
|
217
|
+
</>
|
|
218
|
+
)
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### Grouped
|
|
222
|
+
|
|
223
|
+
Documents under headings that expand, one group open at a time, each a chip — the reference's DocumentChips.
|
|
224
|
+
|
|
225
|
+
```tsx
|
|
226
|
+
import { Documents } from '@deriv-com/dds-marketing'
|
|
227
|
+
|
|
228
|
+
// layout="groups"
|
|
229
|
+
<Documents title="Regulatory documents" description="Our key information documents and policies, by product.">{accordionitems}</Documents>
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### A grid of entries
|
|
233
|
+
|
|
234
|
+
A document per country beside the heading, each behind its mark — the reference's CountryLinkGrid. A page passes each country's flag from the flag icons.
|
|
235
|
+
|
|
236
|
+
```tsx
|
|
237
|
+
import { DocumentLink, Documents } from '@deriv-com/dds-marketing'
|
|
238
|
+
import { FileShieldSolidIcon } from '@deriv-com/dds-marketing/icons'
|
|
239
|
+
|
|
240
|
+
// layout="grid"
|
|
241
|
+
<Documents layout="grid" title="Licences by country" description="Our licence in each country we passport into.">
|
|
242
|
+
<DocumentLink href="/documents/malta.pdf" mark={<FileShieldSolidIcon />} variant="plain">Malta</DocumentLink>
|
|
243
|
+
<DocumentLink href="/documents/germany.pdf" mark={<FileShieldSolidIcon />} variant="plain">Germany</DocumentLink>
|
|
244
|
+
<DocumentLink href="/documents/france.pdf" mark={<FileShieldSolidIcon />} variant="plain">France</DocumentLink>
|
|
245
|
+
<DocumentLink href="/documents/italy.pdf" mark={<FileShieldSolidIcon />} variant="plain">Italy</DocumentLink>
|
|
246
|
+
<DocumentLink href="/documents/spain.pdf" mark={<FileShieldSolidIcon />} variant="plain">Spain</DocumentLink>
|
|
247
|
+
<DocumentLink href="/documents/netherlands.pdf" mark={<FileShieldSolidIcon />} variant="plain">Netherlands</DocumentLink>
|
|
248
|
+
<DocumentLink href="/documents/ireland.pdf" mark={<FileShieldSolidIcon />} variant="plain">Ireland</DocumentLink>
|
|
249
|
+
<DocumentLink href="/documents/austria.pdf" mark={<FileShieldSolidIcon />} variant="plain">Austria</DocumentLink>
|
|
250
|
+
</Documents>
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### Grounds
|
|
254
|
+
|
|
255
|
+
The section takes one of the page's three grounds; the chips keep their own surface on each.
|
|
256
|
+
|
|
257
|
+
```tsx
|
|
258
|
+
import { Documents } from '@deriv-com/dds-marketing'
|
|
259
|
+
|
|
260
|
+
// page
|
|
261
|
+
<Documents title="Regulatory documents" description="Our key information documents and policies, by product." ground="page">{accordionitems}</Documents>
|
|
262
|
+
|
|
263
|
+
// subtle
|
|
264
|
+
<Documents title="Regulatory documents" description="Our key information documents and policies, by product." ground="subtle">{accordionitems}</Documents>
|
|
265
|
+
|
|
266
|
+
// strong
|
|
267
|
+
<Documents title="Regulatory documents" description="Our key information documents and policies, by product." ground="strong">{accordionitems}</Documents>
|
|
268
|
+
```
|
|
@@ -59,7 +59,7 @@ Apply these classes from the generated `downloadBannerParts` constant rather tha
|
|
|
59
59
|
|
|
60
60
|
- `page` — The default, and the page's own white. The card is the recessed gray that sets it off — the reference design's light-2
|
|
61
61
|
- `subtle` — The grey band, with the card white on it — the reference design's light. Painted as the band's tint laid over the page's own ground, so it is the same grey whatever is behind the section
|
|
62
|
-
- `strong` — `color.bg.brand-strong`, the dark band, with the card at color.bg.surface-card-strong and white words on it — the reference design's dark. For a download section a reader should arrive at; the badges are black and keep their own edge on it
|
|
62
|
+
- `strong` — `color.bg.brand-strong`, the dark band, with the card at color.bg.surface-card-strong-on-brand-strong and white words on it — the reference design's dark. For a download section a reader should arrive at; the badges are black and keep their own edge on it
|
|
63
63
|
|
|
64
64
|
Use when: Which of the page's grounds the section paints, and with it the card's fill: the recessed surface on the page, the raised white on the grey band, and the strong card on the dark band — TestimonialRow's three and the reference design's light, light-2 and dark. The ink follows the ground and is not a second decision.
|
|
65
65
|
Never for: Marking importance. Every section on a page painted a ground is a page with no emphasis left.
|
|
@@ -142,6 +142,12 @@ What this is not about is every row of controls. A set of filter chips, a pagina
|
|
|
142
142
|
Guidance only — cannot be checked automatically.
|
|
143
143
|
- **Never nest one interactive element inside another** — Nested interactive elements produce ambiguous hit targets and an unreachable inner control for keyboard and screen-reader users. This is why the rule cannot live on any single component — it constrains Button, Link, CardButton and TextInput simultaneously.
|
|
144
144
|
Guidance only — cannot be checked automatically.
|
|
145
|
+
- **A page has at most one patterned band, between its hero and its closing call to action** — A patterned ground — the halftone, the aurora, the mesh, the grid or the rings — is what makes a band the one a reader stops at, and it only works by being the exception. So a page has at most one, placed between its hero and its closing call to action; the hero's and the call to action's own patterns are theirs and do not count, and the band never goes on either of them.
|
|
146
|
+
|
|
147
|
+
The pattern is the band's first layer, under its content and over nothing. A block that can carry one says so with its own `background` prop — FeatureCards, Stats, TestimonialRow and LogoRows — and draws it there; a section built by hand places a Background with nothing in it as its first child. Never wrap a block in a Background: the block paints its own ground over the pattern and hides it.
|
|
148
|
+
|
|
149
|
+
Only a band whose content is stacked can carry one. Every pattern rises from the band's foot, so the band needs a heading over what it introduces, centred, with the foot left open. A band whose content runs side by side — words beside a picture, a split, columns reaching the foot — puts the glow behind the picture or under the words; it stays on its flat ground.
|
|
150
|
+
Guidance only — cannot be checked automatically.
|
|
145
151
|
- **A section that paints a ground sets the ink to go with it** — A page sits on color.bg.page, and a section that separates itself from it takes one of three grounds. color.bg.subtle is the light one and needs nothing further — the page's own ink still reads on it. The other two are dark and do not: color.bg.brand-strong takes color.fg.on-brand-strong, and color.bg.brand takes color.fg.on-solid. Both are white, and both are written as the role rather than the white they resolve to. Set one of those backgrounds without its ink and the text inherits whatever the page was already using, which is near-black on a dark band — legible to nobody, and invisible to every check here, because each pair passes contrast on its own and nothing can tell whether a section used both.
|
|
146
152
|
|
|
147
153
|
color.bg.brand carries a second limit that is not about forgetting. Its ink measures 3.39:1, which clears the 3:1 a heading needs and misses the 4.5:1 running copy needs. A coral band may carry a headline and a call to action; a paragraph on one is text the reader has to work through at a ratio the waiver on that role does not cover — the waiver says so itself. A section with copy in it takes color.bg.brand-strong, which is near-black and carries white at full contrast.
|
|
@@ -210,6 +210,12 @@ What this is not about is every row of controls. A set of filter chips, a pagina
|
|
|
210
210
|
Guidance only — cannot be checked automatically.
|
|
211
211
|
- **Never nest one interactive element inside another** — Nested interactive elements produce ambiguous hit targets and an unreachable inner control for keyboard and screen-reader users. This is why the rule cannot live on any single component — it constrains Button, Link, CardButton and TextInput simultaneously.
|
|
212
212
|
Guidance only — cannot be checked automatically.
|
|
213
|
+
- **A page has at most one patterned band, between its hero and its closing call to action** — A patterned ground — the halftone, the aurora, the mesh, the grid or the rings — is what makes a band the one a reader stops at, and it only works by being the exception. So a page has at most one, placed between its hero and its closing call to action; the hero's and the call to action's own patterns are theirs and do not count, and the band never goes on either of them.
|
|
214
|
+
|
|
215
|
+
The pattern is the band's first layer, under its content and over nothing. A block that can carry one says so with its own `background` prop — FeatureCards, Stats, TestimonialRow and LogoRows — and draws it there; a section built by hand places a Background with nothing in it as its first child. Never wrap a block in a Background: the block paints its own ground over the pattern and hides it.
|
|
216
|
+
|
|
217
|
+
Only a band whose content is stacked can carry one. Every pattern rises from the band's foot, so the band needs a heading over what it introduces, centred, with the foot left open. A band whose content runs side by side — words beside a picture, a split, columns reaching the foot — puts the glow behind the picture or under the words; it stays on its flat ground.
|
|
218
|
+
Guidance only — cannot be checked automatically.
|
|
213
219
|
- **A section that paints a ground sets the ink to go with it** — A page sits on color.bg.page, and a section that separates itself from it takes one of three grounds. color.bg.subtle is the light one and needs nothing further — the page's own ink still reads on it. The other two are dark and do not: color.bg.brand-strong takes color.fg.on-brand-strong, and color.bg.brand takes color.fg.on-solid. Both are white, and both are written as the role rather than the white they resolve to. Set one of those backgrounds without its ink and the text inherits whatever the page was already using, which is near-black on a dark band — legible to nobody, and invisible to every check here, because each pair passes contrast on its own and nothing can tell whether a section used both.
|
|
214
220
|
|
|
215
221
|
color.bg.brand carries a second limit that is not about forgetting. Its ink measures 3.39:1, which clears the 3:1 a heading needs and misses the 4.5:1 running copy needs. A coral band may carry a headline and a call to action; a paragraph on one is text the reader has to work through at a ratio the waiver on that role does not cover — the waiver says so itself. A section with copy in it takes color.bg.brand-strong, which is near-black and carries white at full contrast.
|
|
@@ -161,6 +161,12 @@ What this is not about is every row of controls. A set of filter chips, a pagina
|
|
|
161
161
|
Guidance only — cannot be checked automatically.
|
|
162
162
|
- **Never nest one interactive element inside another** — Nested interactive elements produce ambiguous hit targets and an unreachable inner control for keyboard and screen-reader users. This is why the rule cannot live on any single component — it constrains Button, Link, CardButton and TextInput simultaneously.
|
|
163
163
|
Guidance only — cannot be checked automatically.
|
|
164
|
+
- **A page has at most one patterned band, between its hero and its closing call to action** — A patterned ground — the halftone, the aurora, the mesh, the grid or the rings — is what makes a band the one a reader stops at, and it only works by being the exception. So a page has at most one, placed between its hero and its closing call to action; the hero's and the call to action's own patterns are theirs and do not count, and the band never goes on either of them.
|
|
165
|
+
|
|
166
|
+
The pattern is the band's first layer, under its content and over nothing. A block that can carry one says so with its own `background` prop — FeatureCards, Stats, TestimonialRow and LogoRows — and draws it there; a section built by hand places a Background with nothing in it as its first child. Never wrap a block in a Background: the block paints its own ground over the pattern and hides it.
|
|
167
|
+
|
|
168
|
+
Only a band whose content is stacked can carry one. Every pattern rises from the band's foot, so the band needs a heading over what it introduces, centred, with the foot left open. A band whose content runs side by side — words beside a picture, a split, columns reaching the foot — puts the glow behind the picture or under the words; it stays on its flat ground.
|
|
169
|
+
Guidance only — cannot be checked automatically.
|
|
164
170
|
- **A section that paints a ground sets the ink to go with it** — A page sits on color.bg.page, and a section that separates itself from it takes one of three grounds. color.bg.subtle is the light one and needs nothing further — the page's own ink still reads on it. The other two are dark and do not: color.bg.brand-strong takes color.fg.on-brand-strong, and color.bg.brand takes color.fg.on-solid. Both are white, and both are written as the role rather than the white they resolve to. Set one of those backgrounds without its ink and the text inherits whatever the page was already using, which is near-black on a dark band — legible to nobody, and invisible to every check here, because each pair passes contrast on its own and nothing can tell whether a section used both.
|
|
165
171
|
|
|
166
172
|
color.bg.brand carries a second limit that is not about forgetting. Its ink measures 3.39:1, which clears the 3:1 a heading needs and misses the 4.5:1 running copy needs. A coral band may carry a headline and a call to action; a paragraph on one is text the reader has to work through at a ratio the waiver on that role does not cover — the waiver says so itself. A section with copy in it takes color.bg.brand-strong, which is near-black and carries white at full contrast.
|
|
@@ -82,6 +82,12 @@ What this is not about is every row of controls. A set of filter chips, a pagina
|
|
|
82
82
|
Guidance only — cannot be checked automatically.
|
|
83
83
|
- **Never nest one interactive element inside another** — Nested interactive elements produce ambiguous hit targets and an unreachable inner control for keyboard and screen-reader users. This is why the rule cannot live on any single component — it constrains Button, Link, CardButton and TextInput simultaneously.
|
|
84
84
|
Guidance only — cannot be checked automatically.
|
|
85
|
+
- **A page has at most one patterned band, between its hero and its closing call to action** — A patterned ground — the halftone, the aurora, the mesh, the grid or the rings — is what makes a band the one a reader stops at, and it only works by being the exception. So a page has at most one, placed between its hero and its closing call to action; the hero's and the call to action's own patterns are theirs and do not count, and the band never goes on either of them.
|
|
86
|
+
|
|
87
|
+
The pattern is the band's first layer, under its content and over nothing. A block that can carry one says so with its own `background` prop — FeatureCards, Stats, TestimonialRow and LogoRows — and draws it there; a section built by hand places a Background with nothing in it as its first child. Never wrap a block in a Background: the block paints its own ground over the pattern and hides it.
|
|
88
|
+
|
|
89
|
+
Only a band whose content is stacked can carry one. Every pattern rises from the band's foot, so the band needs a heading over what it introduces, centred, with the foot left open. A band whose content runs side by side — words beside a picture, a split, columns reaching the foot — puts the glow behind the picture or under the words; it stays on its flat ground.
|
|
90
|
+
Guidance only — cannot be checked automatically.
|
|
85
91
|
- **A section that paints a ground sets the ink to go with it** — A page sits on color.bg.page, and a section that separates itself from it takes one of three grounds. color.bg.subtle is the light one and needs nothing further — the page's own ink still reads on it. The other two are dark and do not: color.bg.brand-strong takes color.fg.on-brand-strong, and color.bg.brand takes color.fg.on-solid. Both are white, and both are written as the role rather than the white they resolve to. Set one of those backgrounds without its ink and the text inherits whatever the page was already using, which is near-black on a dark band — legible to nobody, and invisible to every check here, because each pair passes contrast on its own and nothing can tell whether a section used both.
|
|
86
92
|
|
|
87
93
|
color.bg.brand carries a second limit that is not about forgetting. Its ink measures 3.39:1, which clears the 3:1 a heading needs and misses the 4.5:1 running copy needs. A coral band may carry a headline and a call to action; a paragraph on one is text the reader has to work through at a ratio the waiver on that role does not cover — the waiver says so itself. A section with copy in it takes color.bg.brand-strong, which is near-black and carries white at full contrast.
|