Skip to content
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

Allow to extend the deltaE methods #287

Merged
merged 1 commit into from
Feb 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/deltaE.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import getColor from "./getColor.js";
import defaults from "./defaults.js";
import {isString} from "./util.js";
import * as deltaEMethods from "./deltaE/index.js";
import deltaEMethods from "./deltaE/index.js";

export default function deltaE (c1, c2, o = {}) {
if (isString(o)) {
Expand Down
23 changes: 17 additions & 6 deletions src/deltaE/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
export {default as deltaE76} from "./deltaE76.js";
export {default as deltaECMC} from "./deltaECMC.js";
export {default as deltaE2000} from "./deltaE2000.js";
export {default as deltaEJz} from "./deltaEJz.js";
export {default as deltaEITP} from "./deltaEITP.js";
export {default as deltaEOK} from "./deltaEOK.js";
import deltaE76 from "./deltaE76.js";
import deltaECMC from "./deltaECMC.js";
import deltaE2000 from "./deltaE2000.js";
import deltaEJz from "./deltaEJz.js";
import deltaEITP from "./deltaEITP.js";
import deltaEOK from "./deltaEOK.js";

export { deltaE76, deltaECMC, deltaE2000, deltaEJz, deltaEITP, deltaEOK };
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
export { deltaE76, deltaECMC, deltaE2000, deltaEJz, deltaEITP, deltaEOK };
// We want both a default export so it can be extended
// as well as individual named exports
export {
deltaE76,
deltaECMC,
deltaE2000,
deltaEJz,
deltaEITP,
deltaEOK
};


export default {
deltaE76,
deltaECMC,
deltaE2000,
deltaEJz,
deltaEITP,
deltaEOK,
};
1 change: 1 addition & 0 deletions src/index-fn.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export {uv, xy} from "./chromaticity.js";
export * from "./contrast/index.js";
export {default as deltaE} from "./deltaE.js";
export * from "./deltaE/index.js";
export {default as deltaEMethods} from "./deltaE/index.js";
export * from "./variations.js";
export {
mix, steps, range, isRange
Expand Down
3 changes: 2 additions & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ import "./spaces/index.js";

// Import all DeltaE methods
import deltaE from "./deltaE.js";
import * as deltaEMethods from "./deltaE/index.js";
import deltaEMethods from "./deltaE/index.js";

Color.extend(deltaEMethods);
Color.extend({deltaE});
Object.assign(Color, {deltaEMethods});

// Import optional modules
import * as variations from "./variations.js";
Expand Down
11 changes: 7 additions & 4 deletions types/src/deltaE/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
export type Methods = keyof typeof import(".") extends `deltaE${infer Method}`
? Method
: string;

export { default as deltaE76 } from "./deltaE76";
export { default as deltaECMC } from "./deltaECMC";
export { default as deltaE2000 } from "./deltaE2000";
export { default as deltaEJz } from "./deltaEJz";
export { default as deltaEITP } from "./deltaEITP";
export { default as deltaEOK } from "./deltaEOK";

declare const deltaEMethods: Omit<typeof import("./index"), "default">;
export default deltaEMethods;

export type Methods = keyof typeof deltaEMethods extends `deltaE${infer Method}`
? Method
: string;
1 change: 1 addition & 0 deletions types/src/index-fn.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ export { mix, steps, range, isRange } from "./interpolation";

export * from "./contrast/index";
export * from "./deltaE/index";
export { default as deltaEMethods } from "./deltaE/index";
export * from "./variations";
export * from "./spaces/index-fn";
3 changes: 2 additions & 1 deletion types/src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
contrastDeltaPhi,
} from "./contrast/index";
import deltaE from "./deltaE";
import {
import deltaEMethods, {
deltaE76,
deltaECMC,
deltaE2000,
Expand Down Expand Up @@ -64,6 +64,7 @@ declare module "./color" {
static deltaEJz: typeof deltaEJz;
static deltaEITP: typeof deltaEITP;
static deltaEOK: typeof deltaEOK;
static deltaEMethods: typeof deltaEMethods;

// interpolation
mix: ToColorPrototype<typeof mix>;
Expand Down