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

feat: Add toHexShortString() method #237

Merged
merged 2 commits into from
Feb 14, 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
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,18 @@ const color = new TinyColor('red');
color.toHex8String(); // "#ff0000ff"
```

### toHexShortString

```ts
const color1 = new TinyColor('#ff000000');
color1.toHexShortString(); // "#ff000000"
color1.toHexShortString(true); // "#f000"

const color2 = new TinyColor('#ff0000ff');
color2.toHexShortString(); // "#ff0000"
color2.toHexShortString(true); // "#f00"
```

### toRgb

```ts
Expand Down
12 changes: 10 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ export class TinyColor {
}

/**
* Returns the hex value of the color -with a # appened.
* Returns the hex value of the color -with a # prefixed.
* @param allow3Char will shorten hex value to 3 char if possible
*/
toHexString(allow3Char = false): string {
Expand All @@ -236,13 +236,21 @@ export class TinyColor {
}

/**
* Returns the hex 8 value of the color -with a # appened.
* Returns the hex 8 value of the color -with a # prefixed.
* @param allow4Char will shorten hex value to 4 char if possible
*/
toHex8String(allow4Char = false): string {
return '#' + this.toHex8(allow4Char);
}

/**
* Returns the shorter hex value of the color depends on its alpha -with a # prefixed.
* @param allowShortChar will shorten hex value to 3 or 4 char if possible
*/
toHexShortString(allowShortChar = false): string {
return this.a === 1 ? this.toHexString(allowShortChar) : this.toHex8String(allowShortChar);
}

/**
* Returns the object as a RGBA object.
*/
Expand Down
9 changes: 0 additions & 9 deletions test/conversions.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,4 @@ describe('TinyColor Conversions', () => {
expect(tiny.toHexString()).toBe(new TinyColor(tiny).toHexString());
}
});
it('Alpha compositing correctly', () => {
const tiny1 = new TinyColor('rgba(255,0,0,0.5)');
const tiny2 = new TinyColor('rgba(0,255,0,0.5)');
const tiny3 = new TinyColor('rgba(0,0,255,1)');
const tiny4 = new TinyColor('rgba(0,0,0,0.5)');
expect(tiny1.onBackground(tiny2).toRgbString()).toBe('rgba(170, 85, 0, 0.75)');
expect(tiny1.onBackground(tiny3).toRgbString()).toBe('rgb(128, 0, 128)');
expect(tiny3.onBackground(tiny4).toRgbString()).toBe('rgb(0, 0, 255)');
});
});
13 changes: 13 additions & 0 deletions test/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,10 @@ describe('TinyColor', () => {
expect(new TinyColor('rgba 255 0 0 0').toHex8String()).toBe('#ff000000');
expect(new TinyColor('rgba 255 0 0 1').toHex8String()).toBe('#ff0000ff');
expect(new TinyColor('rgba 255 0 0 1').toHex8String(true)).toBe('#f00f');
expect(new TinyColor('rgba 255 0 0 0').toHexShortString()).toBe('#ff000000');
expect(new TinyColor('rgba 255 0 0 0').toHexShortString(true)).toBe('#f000');
expect(new TinyColor('rgba 255 0 0 1').toHexShortString()).toBe('#ff0000');
expect(new TinyColor('rgba 255 0 0 1').toHexShortString(true)).toBe('#f00');
expect(new TinyColor('rgb 255 0 0').toHex()).toBe('ff0000');
expect(new TinyColor('rgb 255 0 0').toHex(true)).toBe('f00');
expect(new TinyColor('rgba 255 0 0 0.5').toHex8()).toBe('ff000080');
Expand Down Expand Up @@ -757,6 +761,15 @@ describe('TinyColor', () => {
expect(new TinyColor('#ffffff00').onBackground('#000').toHex()).toBe('000000');
expect(new TinyColor('#ffffff77').onBackground('#000').toHex()).toBe('777777');
expect(new TinyColor('#262a6d82').onBackground('#644242').toHex()).toBe('443658');
expect(new TinyColor('rgba(255,0,0,0.5)').onBackground('rgba(0,255,0,0.5)').toRgbString()).toBe(
'rgba(170, 85, 0, 0.75)',
);
expect(new TinyColor('rgba(255,0,0,0.5)').onBackground('rgba(0,0,255,1)').toRgbString()).toBe(
'rgb(128, 0, 128)',
);
expect(new TinyColor('rgba(0,0,255,1)').onBackground('rgba(0,0,0,0.5)').toRgbString()).toBe(
'rgb(0, 0, 255)',
);
});
it('complement', () => {
const complementDoesntModifyInstance = new TinyColor('red');
Expand Down