Skip to content

docs(themes): document the fitted palette generator and surface roles - #936

Open
simeonoff wants to merge 7 commits into
vnextfrom
simeonoff/theming/v30-updates
Open

simeonoff wants to merge 7 commits into
vnextfrom
simeonoff/theming/v30-updates

Conversation

@simeonoff

Copy link
Copy Markdown
Member

Documents Ignite UI Theming 30, which ships with Ignite UI for Angular 22.3.0 and Ignite UI for Web Components 7.5.0: the new fitted palette generator, the surface roles, and the deprecation of the numbered surface shades.

Changes

  • Palette Generation (new, Angular and cross-platform): how the fitted generator builds a palette: seeds and scales, hue and gamut, contrast targets, scale presets, the gray anchor, and the surface roles. Also covers the deprecated numbered surface shades, how the container contrast is measured, and troubleshooting.
  • Palettes (Angular and cross-platform): the surface roles next to the shade variants, how legacy and fitted shades behave when overridden at runtime, and overriding the surface roles instead of --ig-surface-500. The Web Components version notes that the components read the roles from 7.5.0 on.
  • Palettes with Sass (Angular): $scales, $generator, $shade-generator, the surface roles in hand-written palette maps, and migrating off the numbered surface shades.
  • Update Guide (Angular): new 22.2.x to 22.3.x section covering what the ng update migration changes, what it reports, and what to review by hand.
  • Themes Overview (cross-platform): compiling an igniteui-theming stylesheet in React, Web Components, and Blazor, and using it without a Sass toolchain.
  • Accessibility (Angular, EN and JP): adds the Angular copies of the topic that both TOCs already link to.
  • TOCs: Palette Generation added with the new label.

Samples

The topics mark where the palette demos go with commented-out <Sample … wc> embeds. They depend on:

Once both are merged, a follow-up PR adds wcDemosBaseUrl to the docs config and uncomments the embeds.

Related

Checklist:

  • check topic's TOC/menu and paragraph headings
  • Include TOC topic labels in the topic content when it has a valuable update, is new, or is considered preview / beta
  • link to other topics using ./page.mdx or ../relative/path.mdx (.mdx extension required)
  • at the References section at the end of the topic add links to topics, samples, etc
  • reference API documentation instead of adding a section with API

  • use valid component names - [Data] Grid, IgxSelectComponent, <igx-combo>
  • use spell checker tool (VS Code, Grammarly, Microsoft Editor)
  • add inline code blocks for the names of classes / tags / properties
  • add language descriptor for the code blocks
  • check if links function by running the check-api/mdx npm commands
  • check if sample is working and fully visible in the topic (samples pending, see above)
  • check if sample is working and fully visible in the StackBlitz (samples pending, see above)
  • check if code blocks match the code in StackBlitz demo (samples pending, see above)
  • add or update meaningful llms.description metadata and run npm run check:llms-metadata


  • do not resolve requested changes (leave that to the reviewer)

Ignite UI for Angular 22.3.0 and Ignite UI for Web Components 7.5.0 ship Ignite UI Theming 30, whose palette() function builds palettes with a new `fitted` generator by default and gives the surface family named roles. The palette topics now explain both generators and the runtime behavior each produces.

Palette Generation (new, Angular and cross-platform):
- explain seeds and scales, hue and gamut, contrast targets, the scale presets, the gray anchor, and the surface roles
- cover the deprecated numbered surface shades, which every palette still emits, and how the container contrast is measured over base
- add troubleshooting for runtime overrides, --ig-surface-500, and the contrast-target warning

Palettes and Palettes with Sass:
- list the surface roles next to the shade variants, and describe how legacy and fitted shades behave when overridden at runtime
- override the surface roles, not --ig-surface-500, to switch between light and dark surfaces
- document $scales, $generator, $shade-generator, and the surface roles in hand-written palette maps

Update Guide:
- add the 22.2.x to 22.3.x section: the migration adds $generator: 'legacy' to palette() calls, reports the spread calls it can't update, and lists the surface changes to review by hand

Themes Overview (cross-platform):
- show how to compile an igniteui-theming stylesheet in React, Web Components, and Blazor, and how to use it without a Sass toolchain

Also:
- add the Angular copy of the Accessibility topic, which the Angular TOC already links to
- add Palette Generation to both TOCs
- mark the places for the palette demos with commented-out <Sample> embeds; uncomment them once the demos are published in igniteui-webcomponents-samples
Link the Angular palette topics and the 22.3.x update guide section with relative .mdx paths, as the PR checklist requires, and write the sample placeholder comments as {/*…*/} so markdownlint doesn't read them as emphasis.
The Japanese Angular TOC already links to themes/accessibility.mdx, but the page was missing, so the entry dropped out of the sidebar. Add the Japanese copy synced from the cross-platform topic, matching the English copy.
@adrianptrv adrianptrv added ✅ status: verified Applies to PRs that have passed manual verification and removed ❌ status: awaiting-test PRs awaiting manual verification labels Oct 22, 2026
adrianptrv
adrianptrv previously approved these changes Oct 22, 2026
…0-updates

# Conflicts:
#	docs/angular/package.json
#	docs/xplat/package.json
#	package-lock.json
#	package.json
@simeonoff
simeonoff marked this pull request as ready for review October 22, 2026 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

theming ✅ status: verified Applies to PRs that have passed manual verification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants