Skip to content

Add TypeScript typings for addIconParts #343

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.

Sign up for GitHub

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
lhapaipai wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add TypeScript typings for addIconParts #343

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f02ded
add typing for addIconParts
lhapaipai Mar 18, 2026
b76e783
fix return type of addIconParts
lhapaipai Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ type DrawText = {
stroke: string | false;
strokedasharray?: string;
strokewidth?: number;
text: string;
};

type DrawSVG = {
Expand Down Expand Up @@ -334,6 +335,15 @@ export type ExtensionFunction = (

export function addSymbolPart(extension: ExtensionFunction): typeof _default;

export type IconPartsFunction = (
this: Symbol,
iconParts: Record<string, DrawInstruction | DrawInstruction[]>,
metadata: SymbolMetadata,
colors: SymbolColors
) => void;

export function addIconParts(iconParts: IconPartsFunction): typeof _default;

declare const _default: {
Symbol: typeof Symbol;
BBox: BBoxConstructor;
Expand All @@ -347,6 +357,7 @@ declare const _default: {
getVersion: typeof getVersion;
setStandard: typeof setStandard;
addSymbolPart: typeof addSymbolPart;
addIconParts: typeof addIconParts;
};

export default _default;