Move color palette functions to @elastic/eui-theme-common to make them individually importable by sphilipse · Pull Request #10247 · elastic/eui

sphilipse · 2026-10-27T17:48:25Z

Summary

Makes euiPaletteColorBlind and the other euiPalette* functions individually importable — without loading the whole @elastic/eui package — by moving their implementation to @elastic/eui-theme-common.

Kibana server code needs the palettes, but import { euiPaletteColorBlind } from '@elastic/eui' loads the entire EUI codebase. In elastic/kibana#300920 we will remove EUI from the server, but that requires being able to deep import the palettes.

The main controversial change is wrapping the palette functions in EUI so we still generate docs for them there.

Makes euiPaletteColorBlind and the other palette functions individually importable without loading the whole @elastic/eui package. Kibana server code needs the palettes (pure, chroma-js based) but a single import of the @elastic/eui barrel loads 1,100+ modules of React components into the Node.js server process. - colorPalette and the euiPalette* functions move to @elastic/eui-theme-common, next to the vis color store they read from; the original modules in @elastic/eui re-export them unchanged, so the public API of @elastic/eui is unaffected (including types). - Store initialization moves with them: the vis color store previously got its default colors from @elastic/eui importing @elastic/eui-theme-borealis; now @elastic/eui-theme-borealis initializes the store with its default colors on import (getInstance is idempotent), so palettes work when only the theme packages are loaded. EuiVisColorStore.getInstance() without arguments now throws a descriptive error if the store was never initialized. - React hooks (useEuiPalette*) stay in @elastic/eui. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

The color-palettes docs page renders PropTable from docgen output, which only scanned @elastic/eui/src. With the palette implementations moved to @elastic/eui-theme-common, euiPaletteColorBlind disappeared from dist/services/color and static site generation crashed on /docs/utilities/color-palettes/. eui-docgen now runs a second pass over @elastic/eui-theme-common, emitting under dist/eui-theme-common/, and the page imports the palette definitions from there. Output shape is unchanged (verified: all 13 palette functions emitted with the same displayName/path/extends/props structure). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

This reverts commit 05015f9.

The color-palettes docs page renders PropTables from docgen data generated from @elastic/eui/src; bare re-exports of the moved palette functions dropped them from that output and broke the docs build. Wrap the @elastic/eui-theme-common implementations in thin, JSDoc'd functions with the original signatures so docgen keeps emitting them (verified locally: euiPaletteColorBlind present again with all six props). No API change. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Removed comments about the implementation location and re-export.

Copilot

🟡 Changes recommended

Removing the color-store dependency leaves default colors uninitialized for fresh deep imports, causing palette calls and visualization_colors module evaluation to throw unless explicit colors or a prior theme import are present.

1 open issue

Preserve EUI palette store initialization for deep imports · New

What changed in this PR

Moves palette utilities into @elastic/eui-theme-common so consumers such as Kibana server code can use them without loading the full EUI package.

Changes:

Relocates palette implementations and types, retaining EUI wrappers and compatibility exports.
Initializes the visualization color store on Borealis import and adds an error for access before initialization.
Documents the changes in all three affected packages.

File	Description
`packages/eui/src/services/color/eui_palettes.ts`	Wraps relocated functions while retaining docblocks.
`packages/eui/src/services/color/color_palette.ts`	Re-exports the shared interpolation utility and constant.
`packages/eui/changelogs/upcoming/10247.md`	Documents relocation and initialization changes.
`packages/eui-theme-common/src/services/vis_color_store.ts`	Allows argument-free access after initialization.
`packages/eui-theme-common/src/services/index.ts`	Exports the palette utilities.
`packages/eui-theme-common/src/services/eui_palettes.ts`	Houses palette implementations with lazy store access.
`packages/eui-theme-common/src/services/color_palette.ts`	Houses the color interpolation implementation.
`packages/eui-theme-common/changelogs/upcoming/10247.md`	Documents new exports and store behavior.
`packages/eui-theme-borealis/src/index.ts`	Initializes the store with default visualization colors.
`packages/eui-theme-borealis/changelogs/upcoming/10247.md`	Documents initialization on import.

_{Review effort: Balanced}

- @elastic/eui eui_palettes.ts side-effect-imports ./vis_color_store again, so a standalone deep import of the module (and the eager VISUALIZATION_COLORS evaluation in services/color) initializes the vis color store with theme defaults exactly as before the palette move. - Add vis color store tests for the new initialization contract: getInstance() before init throws descriptively, no-argument getInstance() after init returns the existing instance, palettes resolve default colors once a theme initializes the store, and palette calls without any theme loaded throw. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

infra-vault-gh-plugin-prod · 2026-10-29T17:01:56Z

💚 Build Succeeded

Buildkite Build
Commit: 8a4c6f2

History

💚 Build #8394 succeeded 544b970
💚 Build #8393 succeeded d03540c
💚 Build #8382 succeeded f66b8ae
💚 Build #8380 succeeded b830e0d
💚 Build #8360 succeeded 81c4dbc

infra-vault-gh-plugin-prod · 2026-10-29T17:07:10Z

💚 Build Succeeded

Buildkite Build
Commit: 8a4c6f2
Documentation website
Storybook
✅ Visual regression tests passed

History

💚 Build #6060 succeeded 8a4c6f2
💚 Build #6048 succeeded 544b970
💚 Build #6046 succeeded d03540c
💚 Build #6045 succeeded d03540c
💚 Build #6031 succeeded f66b8ae
💔 Build #6027 failed b830e0d

github-actions · 2026-10-30T17:58:57Z

Kibana Regression Integration Test

Status: 💚 Kibana CI passed
Branch: update-dependencies/pr-10247
Kibana PR: elastic/kibana#302164

acstll

🟢 Left a single comment with a minor concern, other than that LGTM!

(Approving to unblock, but I say let's wait for the regression CI run in Kibana to be safe.)

acstll · 2026-10-30T18:19:04Z

+// Initializes the vis color store with theme defaults, as importing this
+// module always has; without it a standalone deep import of this module (or
+// evaluating VISUALIZATION_COLORS before a theme loads) would throw.
+import './vis_color_store';


🤖 there's a concern I couldn't confirm about this file being dropped by bundlers in some cases (not in Kibana that bundles all of EUI)

the suggested fix is adding it to sideEffects in package.json

"sideEffects": [ "*.css", "*.scss", "**/services/color/vis_color_store.js" ]

sphilipse and others added 2 commits October 27, 2026 18:45

Add changelog entry

81c4dbc

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

sphilipse mentioned this pull request Oct 27, 2026

Stop loading @elastic/eui and React UI libraries in the Kibana server elastic/kibana#300920

Closed

sphilipse and others added 9 commits October 28, 2026 14:12

Update changelog for colorPalette and euiPalette changes

636dae7

Add theme package changelog entries

5ac9466

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Revert "Fix docs build: emit docgen data for @elastic/eui-theme-common"

b830e0d

This reverts commit 05015f9.

Update 10247.md

6dc13e9

Delete packages/eui-theme-common/src/services/color_palette.test.ts

d2e2379

Clean up comments in color_palette.ts

d03540c

Removed comments about the implementation location and re-export.

Update eui_palettes.ts

544b970

sphilipse marked this pull request as ready for review October 29, 2026 15:55

Copilot AI balanced review requested due to automatic review settings October 29, 2026 15:55

sphilipse requested a review from a team as a code owner October 29, 2026 15:55

Copilot started reviewing on behalf of sphilipse October 29, 2026 15:55

View session

Copilot AI reviewed Oct 29, 2026

View reviewed changes

Comment thread packages/eui/src/services/color/eui_palettes.ts Resolved

infra-vault-gh-plugin-prod Bot reviewed Oct 29, 2026

View reviewed changes

Comment thread packages/eui-theme-common/src/services/vis_color_store.ts Resolved

Comment thread packages/eui/src/services/color/eui_palettes.ts Resolved

sphilipse mentioned this pull request Oct 30, 2026

Keep visualization color and constant imports EUI-free in server-reachable code elastic/kibana#302021

Draft

Dosant added the ci:regression-integration-test-kibana Run a Regression Integration Test in Kibana against this PR label Oct 30, 2026

elastic-vault-github-plugin-prod Bot mentioned this pull request Oct 30, 2026

[DO NOT MERGE] EUI Regression Integration Test - elastic/eui#10247 elastic/kibana#302164

Draft

acstll approved these changes Oct 30, 2026

View reviewed changes

Navigation Menu

Repository navigation

Move color palette functions to @elastic/eui-theme-common to make them individually importable - #10247

Move color palette functions to @elastic/eui-theme-common to make them individually importable#10247
sphilipse wants to merge 12 commits into
mainfrom
palettes-importable-from-theme-common

sphilipse commented Oct 27, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

infra-vault-gh-plugin-prod Bot commented Oct 29, 2026

Uh oh!

infra-vault-gh-plugin-prod Bot commented Oct 29, 2026

Uh oh!

github-actions Bot commented Oct 30, 2026 •

edited

Loading

Uh oh!

acstll left a comment •

edited

Loading

Uh oh!

acstll Oct 30, 2026

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

sphilipse commented Oct 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

infra-vault-gh-plugin-prod Bot commented Oct 29, 2026

💚 Build Succeeded

History

Uh oh!

infra-vault-gh-plugin-prod Bot commented Oct 29, 2026

💚 Build Succeeded

History

Uh oh!

github-actions Bot commented Oct 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kibana Regression Integration Test

Uh oh!

acstll left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

acstll Oct 30, 2026

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sphilipse commented Oct 27, 2026 •

edited

Loading

github-actions Bot commented Oct 30, 2026 •

edited

Loading

acstll left a comment •

edited

Loading