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

Fix RGBA calc error when change alpha #184

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/components/HexAlphaColorPicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ import React from "react";
import { AlphaColorPicker } from "./common/AlphaColorPicker";
import { ColorModel, ColorPickerBaseProps } from "../types";
import { equalHex } from "../utils/compare";
import { hexToHsva, hsvaToHex } from "../utils/convert";
import { hexToHsva, hsvaToHex, updateAlphaFromString } from "../utils/convert";

const colorModel: ColorModel<string> = {
defaultColor: "0001",
toHsva: hexToHsva,
fromHsva: hsvaToHex,
equal: equalHex,
updateAlpha: updateAlphaFromString,
};

export const HexAlphaColorPicker = (props: Partial<ColorPickerBaseProps<string>>): JSX.Element => (
Expand Down
3 changes: 2 additions & 1 deletion src/components/HslaColorPicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ import React from "react";
import { AlphaColorPicker } from "./common/AlphaColorPicker";
import { ColorModel, ColorPickerBaseProps, HslaColor } from "../types";
import { equalColorObjects } from "../utils/compare";
import { hslaToHsva, hsvaToHsla } from "../utils/convert";
import { hslaToHsva, hsvaToHsla, updateAlphaFromObject } from "../utils/convert";

const colorModel: ColorModel<HslaColor> = {
defaultColor: { h: 0, s: 0, l: 0, a: 1 },
toHsva: hslaToHsva,
fromHsva: hsvaToHsla,
equal: equalColorObjects,
updateAlpha: updateAlphaFromObject,
};

export const HslaColorPicker = (props: Partial<ColorPickerBaseProps<HslaColor>>): JSX.Element => (
Expand Down
3 changes: 2 additions & 1 deletion src/components/HslaStringColorPicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ import React from "react";
import { AlphaColorPicker } from "./common/AlphaColorPicker";
import { ColorModel, ColorPickerBaseProps } from "../types";
import { equalColorString } from "../utils/compare";
import { hslaStringToHsva, hsvaToHslaString } from "../utils/convert";
import { hslaStringToHsva, hsvaToHslaString, updateAlphaFromString } from "../utils/convert";

const colorModel: ColorModel<string> = {
defaultColor: "hsla(0, 0%, 0%, 1)",
toHsva: hslaStringToHsva,
fromHsva: hsvaToHslaString,
equal: equalColorString,
updateAlpha: updateAlphaFromString,
};

export const HslaStringColorPicker = (
Expand Down
3 changes: 2 additions & 1 deletion src/components/HsvaColorPicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ import React from "react";
import { AlphaColorPicker } from "./common/AlphaColorPicker";
import { ColorModel, ColorPickerBaseProps, HsvaColor } from "../types";
import { equalColorObjects } from "../utils/compare";
import { roundHsva } from "../utils/convert";
import { roundHsva, updateAlphaFromObject } from "../utils/convert";

const colorModel: ColorModel<HsvaColor> = {
defaultColor: { h: 0, s: 0, v: 0, a: 1 },
toHsva: (hsva) => hsva,
fromHsva: roundHsva,
equal: equalColorObjects,
updateAlpha: updateAlphaFromObject,
};

export const HsvaColorPicker = (props: Partial<ColorPickerBaseProps<HsvaColor>>): JSX.Element => (
Expand Down
3 changes: 2 additions & 1 deletion src/components/HsvaStringColorPicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ import React from "react";
import { AlphaColorPicker } from "./common/AlphaColorPicker";
import { ColorModel, ColorPickerBaseProps } from "../types";
import { equalColorString } from "../utils/compare";
import { hsvaStringToHsva, hsvaToHsvaString } from "../utils/convert";
import { hsvaStringToHsva, hsvaToHsvaString, updateAlphaFromString } from "../utils/convert";

const colorModel: ColorModel<string> = {
defaultColor: "hsva(0, 0%, 0%, 1)",
toHsva: hsvaStringToHsva,
fromHsva: hsvaToHsvaString,
equal: equalColorString,
updateAlpha: updateAlphaFromString,
};

export const HsvaStringColorPicker = (
Expand Down
3 changes: 2 additions & 1 deletion src/components/RgbaColorPicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ import React from "react";
import { AlphaColorPicker } from "./common/AlphaColorPicker";
import { ColorModel, ColorPickerBaseProps, RgbaColor } from "../types";
import { equalColorObjects } from "../utils/compare";
import { rgbaToHsva, hsvaToRgba } from "../utils/convert";
import { rgbaToHsva, hsvaToRgba, updateAlphaFromObject } from "../utils/convert";

const colorModel: ColorModel<RgbaColor> = {
defaultColor: { r: 0, g: 0, b: 0, a: 1 },
toHsva: rgbaToHsva,
fromHsva: hsvaToRgba,
equal: equalColorObjects,
updateAlpha: updateAlphaFromObject,
};

export const RgbaColorPicker = (props: Partial<ColorPickerBaseProps<RgbaColor>>): JSX.Element => (
Expand Down
3 changes: 2 additions & 1 deletion src/components/RgbaStringColorPicker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ import React from "react";
import { AlphaColorPicker } from "./common/AlphaColorPicker";
import { ColorModel, ColorPickerBaseProps } from "../types";
import { equalColorString } from "../utils/compare";
import { rgbaStringToHsva, hsvaToRgbaString } from "../utils/convert";
import { rgbaStringToHsva, hsvaToRgbaString, updateAlphaFromString } from "../utils/convert";

const colorModel: ColorModel<string> = {
defaultColor: "rgba(0, 0, 0, 1)",
toHsva: rgbaStringToHsva,
fromHsva: hsvaToRgbaString,
equal: equalColorString,
updateAlpha: updateAlphaFromString,
};

export const RgbaStringColorPicker = (
Expand Down
14 changes: 12 additions & 2 deletions src/hooks/useColorManipulation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,20 @@ export function useColorManipulation<T extends AnyColor>(
// Trigger `onChange` callback only if an updated color is different from cached one;
// save the new color to the ref to prevent unnecessary updates
useEffect(() => {
let newColor;
const { a, ...hsv } = hsva;
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const { a: _, ...cacheHsv } = cache.current.hsva;

// When alpha channel is changed, use cached RGB values to prevent rounding errors
const newColor = equalColorObjects(hsv, cacheHsv)
? colorModel.updateAlpha
? colorModel.updateAlpha(cache.current.color, a)
: cache.current.color
: colorModel.fromHsva(hsva);

if (
!equalColorObjects(hsva, cache.current.hsva) &&
!colorModel.equal((newColor = colorModel.fromHsva(hsva)), cache.current.color)
!colorModel.equal(newColor, cache.current.color)
) {
cache.current = { hsva, color: newColor };
onChangeCallback(newColor);
Expand Down
1 change: 1 addition & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export interface ColorModel<T extends AnyColor> {
toHsva: (defaultColor: T) => HsvaColor;
fromHsva: (hsva: HsvaColor) => T;
equal: (first: T, second: T) => boolean;
updateAlpha?: (color: T, alpha: number) => T;
}

type ColorPickerHTMLAttributes = Omit<
Expand Down
11 changes: 11 additions & 0 deletions src/utils/convert.ts
Original file line number Diff line number Diff line change
Expand Up @@ -204,3 +204,14 @@ export const hsvaToHsv = (hsva: HsvaColor): HsvColor => {
const { h, s, v } = roundHsva(hsva);
return { h, s, v };
};

export const updateAlphaFromString = (color: string, alpha: number): string => {
return color.replace(/\d+\.\d+\)/, `${alpha})`);
};

export const updateAlphaFromObject = <T extends RgbaColor | HslaColor | HsvaColor>(
color: T,
alpha: number
): T => {
return Object.assign({}, color, { a: alpha });
};