Repository navigation
Import Figma composed colors with authored opacity #883
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
heddendorp
wants to merge
2
commits into
terrazzoapp:main
Choose a base branch
from
heddendorp:codex/figma-composed-colors
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@terrazzo/cli": patch | ||
| --- | ||
|
|
||
| Import Figma composed color variables with numeric or aliased opacity instead of emitting undefined color components. Resolve composed values for the corresponding named mode (or the referenced collection default), include nested alias dependencies, and detect cyclic references. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| import type { LocalVariable, LocalVariableCollection, RGBA } from '@figma/rest-api-spec'; | ||
|
|
||
| import { formatName } from './lib.js'; | ||
|
|
||
| export function getAliasID(value: unknown): string | undefined { | ||
| if ( | ||
| typeof value === 'object' && | ||
| value && | ||
| 'type' in value && | ||
| value.type === 'VARIABLE_ALIAS' && | ||
| 'id' in value && | ||
| typeof value.id === 'string' | ||
| ) { | ||
| return value.id; | ||
| } | ||
| return undefined; | ||
| } | ||
|
|
||
| export function isComposedColor(value: unknown): value is { color: unknown; opacity: unknown } { | ||
| return typeof value === 'object' && value !== null && 'color' in value && 'opacity' in value; | ||
| } | ||
|
|
||
| export function getAliasIDs(value: unknown): string[] { | ||
| const id = getAliasID(value); | ||
| if (id) { | ||
| return [id]; | ||
| } | ||
| return isComposedColor(value) ? [...getAliasIDs(value.color), ...getAliasIDs(value.opacity)] : []; | ||
| } | ||
|
|
||
| export function resolveComposedColor( | ||
| value: { color: unknown; opacity: unknown }, | ||
| modeID: string, | ||
| { | ||
| variables, | ||
| collections, | ||
| remoteIDs, | ||
| }: { | ||
| variables: Record<string, LocalVariable>; | ||
| collections: Record<string, LocalVariableCollection>; | ||
| remoteIDs: Set<string>; | ||
| }, | ||
| ): RGBA | undefined { | ||
| const modeName = Object.values(collections) | ||
| .flatMap((collection) => collection.modes) | ||
| .find((mode) => mode.modeId === modeID)?.name; | ||
| const active = new Set<string>(); | ||
|
|
||
| function resolve(input: unknown): unknown { | ||
| const id = getAliasID(input); | ||
| if (id) { | ||
| const variable = variables[id]; | ||
| if (!variable) { | ||
| remoteIDs.add(id); | ||
| return undefined; | ||
| } | ||
| if (active.has(id)) { | ||
| throw new Error(`Cyclic Figma composed color alias: ${id}`); | ||
| } | ||
| const collection = collections[variable.variableCollectionId]; | ||
| if (!collection) { | ||
| throw new Error(`Missing Figma collection for composed color alias: ${id}`); | ||
| } | ||
| const targetModeID = | ||
| modeID in variable.valuesByMode | ||
| ? modeID | ||
| : (collection.modes.find( | ||
| (mode) => modeName !== undefined && formatName(mode.name) === formatName(modeName), | ||
| )?.modeId ?? collection.defaultModeId); | ||
| if (!(targetModeID in variable.valuesByMode)) { | ||
| throw new Error(`Missing Figma mode value for composed color alias: ${id}`); | ||
| } | ||
| active.add(id); | ||
| const resolved = resolve(variable.valuesByMode[targetModeID]); | ||
|
|
||
| active.delete(id); | ||
| return resolved; | ||
| } | ||
| if (isComposedColor(input)) { | ||
| const color = resolve(input.color); | ||
| const opacity = resolve(input.opacity); | ||
| if (color === undefined || opacity === undefined) { | ||
| return undefined; | ||
| } | ||
| if ( | ||
| typeof color !== 'object' || | ||
| color === null || | ||
| !['r', 'g', 'b'].every( | ||
| (channel) => | ||
| channel in color && | ||
| typeof (color as Record<string, unknown>)[channel] === 'number' && | ||
| Number.isFinite((color as Record<string, number>)[channel]), | ||
| ) | ||
| ) { | ||
| throw new TypeError('Figma composed color must resolve to RGB or RGBA.'); | ||
| } | ||
| if ( | ||
| typeof opacity !== 'number' || | ||
| !Number.isFinite(opacity) || | ||
| opacity < 0 || | ||
| opacity > 100 | ||
| ) { | ||
| throw new TypeError( | ||
| 'Figma composed color opacity must resolve to a percentage from 0 to 100.', | ||
| ); | ||
| } | ||
| const { r, g, b } = color as RGBA; | ||
| // Composed opacity is independently authored, not multiplied by the source alpha. | ||
| return { r, g, b, a: opacity / 100 }; | ||
| } | ||
| return input; | ||
| } | ||
|
|
||
| return resolve(value) as RGBA | undefined; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.