@skyux/colorpicker 7.5.0 → 7.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/documentation.json +41 -41
  2. package/esm2020/lib/modules/colorpicker/colorpicker-input.directive.mjs +7 -7
  3. package/esm2020/lib/modules/colorpicker/colorpicker.component.mjs +5 -5
  4. package/esm2020/lib/modules/colorpicker/types/colorpicker-cmyk.mjs +1 -1
  5. package/esm2020/lib/modules/colorpicker/types/colorpicker-hsla.mjs +1 -1
  6. package/esm2020/lib/modules/colorpicker/types/colorpicker-hsva.mjs +1 -1
  7. package/esm2020/lib/modules/colorpicker/types/colorpicker-message-type.mjs +2 -2
  8. package/esm2020/lib/modules/colorpicker/types/colorpicker-message.mjs +1 -1
  9. package/esm2020/lib/modules/colorpicker/types/colorpicker-output.mjs +1 -1
  10. package/esm2020/lib/modules/colorpicker/types/colorpicker-rgba.mjs +1 -1
  11. package/fesm2015/skyux-colorpicker.mjs +11 -11
  12. package/fesm2015/skyux-colorpicker.mjs.map +1 -1
  13. package/fesm2020/skyux-colorpicker.mjs +11 -11
  14. package/fesm2020/skyux-colorpicker.mjs.map +1 -1
  15. package/lib/modules/colorpicker/colorpicker-input.directive.d.ts +6 -6
  16. package/lib/modules/colorpicker/colorpicker.component.d.ts +7 -7
  17. package/lib/modules/colorpicker/types/colorpicker-cmyk.d.ts +5 -5
  18. package/lib/modules/colorpicker/types/colorpicker-hsla.d.ts +6 -6
  19. package/lib/modules/colorpicker/types/colorpicker-hsva.d.ts +8 -8
  20. package/lib/modules/colorpicker/types/colorpicker-message-type.d.ts +1 -1
  21. package/lib/modules/colorpicker/types/colorpicker-message.d.ts +1 -1
  22. package/lib/modules/colorpicker/types/colorpicker-output.d.ts +8 -8
  23. package/lib/modules/colorpicker/types/colorpicker-rgba.d.ts +6 -6
  24. package/package.json +7 -7
@@ -17,7 +17,7 @@ export declare class SkyColorpickerInputDirective implements OnInit, OnChanges,
17
17
  */
18
18
  skyColorpickerInput: SkyColorpickerComponent;
19
19
  /**
20
- * Specifies an initial color to load in the colorpicker. Use a reactive or
20
+ * The initial color to load in the colorpicker. Use a reactive or
21
21
  * template-driven form to set this value. This property is deprecated. As an alternative,
22
22
  * we recommend the `formControlName` property on reactive forms or `ngModel` on
23
23
  * template-driven forms. See the demo for examples.
@@ -33,25 +33,25 @@ export declare class SkyColorpickerInputDirective implements OnInit, OnChanges,
33
33
  */
34
34
  returnFormat: string;
35
35
  /**
36
- * Specifies the format to use for the color when the colorpicker uses a native input
36
+ * The format for the color when the colorpicker uses a native input
37
37
  * element such as a standard text input or a button. This property accepts `rgba`, `hex`,
38
38
  * or `hsla`, but we do not recommend using it because users never see or use its value.
39
39
  * Instead, if you need to access this format value, see the demo for an example.
40
- *@default "rgba"
40
+ * @default "rgba"
41
41
  */
42
42
  outputFormat: string;
43
43
  /**
44
- * Specifies an array of colors to load as preset choices. The colorpicker displays the
44
+ * The array of colors to load as preset choices. The colorpicker displays the
45
45
  * colors in a series of 12 boxes for users to select.
46
46
  */
47
47
  presetColors: string[];
48
48
  /**
49
- * Specifies the type of transparency to use in the transparency slider.
49
+ * The type of transparency in the transparency slider.
50
50
  *@default "hex6"
51
51
  */
52
52
  alphaChannel: string;
53
53
  /**
54
- * Indicates whether to display a transparency slider for users to select transparency
54
+ * Whether to display a transparency slider for users to select transparency
55
55
  * levels.
56
56
  */
57
57
  allowTransparency: boolean;
@@ -13,31 +13,31 @@ import { SkyColorpickerResult } from './types/colorpicker-result';
13
13
  import { SkyColorpickerRgba } from './types/colorpicker-rgba';
14
14
  import * as i0 from "@angular/core";
15
15
  /**
16
- * Provides a SKY UX-themed replacement for the HTML `input` element with `type="color"`.
16
+ * The SKY UX-themed replacement for the HTML `input` element with `type="color"`.
17
17
  * The value that users select is driven through the `ngModel` attribute specified on
18
18
  * the `input` element.
19
19
  */
20
20
  export declare class SkyColorpickerComponent implements OnInit, OnDestroy {
21
21
  #private;
22
22
  /**
23
- * Specifies the name of the [Font Awesome 4.7](https://fontawesome.com/v4.7/icons/) icon to overlay on top of the picker. Do not specify the `fa fa-` classes.
23
+ * The name of the [Font Awesome 4.7](https://fontawesome.com/v4.7/icons/) icon to overlay on top of the picker. Do not specify the `fa fa-` classes.
24
24
  * @internal
25
25
  */
26
26
  pickerButtonIcon: string | undefined;
27
27
  /**
28
- * Specifies the type of icon to display. Specifying `fa` will display a Font Awesome icon, while specifying `skyux` will display an icon from the custom SKY UX icon font. Note that the custom SKY UX icon font is currently in beta.
28
+ * The type of icon to display. Specifying `fa` will display a Font Awesome icon, while specifying `skyux` will display an icon from the custom SKY UX icon font. Note that the custom SKY UX icon font is currently in beta.
29
29
  * @internal
30
30
  */
31
31
  pickerButtonIconType: SkyIconType;
32
32
  /**
33
- * Specifies an ARIA label for the colorpicker. This sets the colorpicker's `aria-label` attribute
33
+ * The ARIA label for the colorpicker. This sets the colorpicker's `aria-label` attribute
34
34
  * [to support accessibility](https://developer.blackbaud.com/skyux/components/checkbox#accessibility)
35
35
  * when the colorpicker does not include a visible label. If the colorpicker includes a visible label, use `labelledBy` instead.
36
36
  * @default "Select color value"
37
37
  */
38
38
  label: string | undefined;
39
39
  /**
40
- * Specifies the HTML element ID (without the leading `#`) of the element that labels the
40
+ * The HTML element ID (without the leading `#`) of the element that labels the
41
41
  * colorpicker. This sets the colorpicker's `aria-labelledby` attribute
42
42
  * [to support accessibility](https://developer.blackbaud.com/skyux/components/checkbox#accessibility).
43
43
  * If the colorpicker does not include a visible label, use `label` instead.
@@ -52,12 +52,12 @@ export declare class SkyColorpickerComponent implements OnInit, OnDestroy {
52
52
  */
53
53
  selectedColorApplied: EventEmitter<SkyColorpickerResult>;
54
54
  /**
55
- * Provides an observable to send commands to the colorpicker. The commands should
55
+ * The observable to send commands to the colorpicker. The commands should
56
56
  * respect the `SkyColorPickerMessage` type.
57
57
  */
58
58
  messageStream: Subject<SkyColorpickerMessage>;
59
59
  /**
60
- * Indicates whether to display a reset button to let users return to the default color.
60
+ * Whether to display a reset button to let users return to the default color.
61
61
  */
62
62
  showResetButton: boolean;
63
63
  set disabled(value: boolean);
@@ -1,21 +1,21 @@
1
1
  /**
2
- * Specifies colors as a combination of cyan, magenta, yellow, and black.
2
+ * Colors specified as a combination of cyan, magenta, yellow, and black.
3
3
  */
4
4
  export interface SkyColorpickerCmyk {
5
5
  /**
6
- * Specifies the percentage of cyan to use.
6
+ * The percentage of cyan.
7
7
  */
8
8
  cyan: number;
9
9
  /**
10
- * Specifies the percentage of magenta to use.
10
+ * The percentage of magenta.
11
11
  */
12
12
  magenta: number;
13
13
  /**
14
- * Specifies the percentage of yellow to use.
14
+ * The percentage of yellow.
15
15
  */
16
16
  yellow: number;
17
17
  /**
18
- * Specifies the percentage of black to use.
18
+ * The percentage of black.
19
19
  */
20
20
  key: number;
21
21
  }
@@ -1,25 +1,25 @@
1
1
  /**
2
- * Specifies colors as a combination of hue, saturation, and lightness with an alpha
3
- * channel that specifies the opacity of the color.
2
+ * Colors specified as a combination of hue, saturation, and lightness with an alpha
3
+ * channel to set the opacity.
4
4
  */
5
5
  export interface SkyColorpickerHsla {
6
6
  /**
7
- * Specifies the hue, which is a degree on the color wheel from 0 to 360.
7
+ * The hue, which is a degree on the color wheel from 0 to 360.
8
8
  * 0 is red, 120 is green, and 240 is blue.
9
9
  */
10
10
  hue: number;
11
11
  /**
12
- * Specifies the saturation, which is a percentage value where 0 percent is a
12
+ * The saturation, which is a percentage value where 0 percent is a
13
13
  * shade of gray and 100 percent is the full color.
14
14
  */
15
15
  saturation: number;
16
16
  /**
17
- * Specifies the lightness, which is a percentage value where 0 percent is
17
+ * The lightness, which is a percentage value where 0 percent is
18
18
  * black and 100 percent is white.
19
19
  */
20
20
  lightness: number;
21
21
  /**
22
- * Specifies the alpha channel to set the opacity.
22
+ * The alpha channel to set the opacity.
23
23
  */
24
24
  alpha: number;
25
25
  }
@@ -1,26 +1,26 @@
1
1
  /**
2
- * Specifies colors as a combination of hue, saturation, and value with an alpha
3
- * channel that specifies the opacity of the color.
2
+ * Colors specified as a combination of hue, saturation, and value with an alpha
3
+ * channel to set the opacity.
4
4
  */
5
5
  export interface SkyColorpickerHsva {
6
6
  /**
7
- * Specifies the hue, which is a degree on the color wheel from 0 to 360.
7
+ * The hue, which is a degree on the color wheel from 0 to 360.
8
8
  * 0 is red, 120 is green, and 240 is blue.
9
9
  */
10
10
  hue: number;
11
11
  /**
12
- * Specifies the saturation, which is a percentage value where 0 percent is a
12
+ * The saturation, which is a percentage value where 0 percent is a
13
13
  * shade of gray and 100 percent is the full color.
14
14
  */
15
15
  saturation: number;
16
16
  /**
17
- * Specifies the value, which is a percentage value that describes the brightness
18
- * or intensity of the color where 0 is completely black and 100 is the brightest
19
- * and reveals the most color.
17
+ * The brightness or intensity, which is a percentage value of the
18
+ * color where 0 is completely black and 100 is the brightest and
19
+ * reveals the most color.
20
20
  */
21
21
  value: number;
22
22
  /**
23
- * Specifies the alpha channel to set the opacity.
23
+ * The alpha channel to set the opacity.
24
24
  */
25
25
  alpha: number;
26
26
  }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Specifies the commands to provide the colorpicker.
2
+ * The commands to provide the colorpicker.
3
3
  */
4
4
  export declare enum SkyColorpickerMessageType {
5
5
  /**
@@ -4,7 +4,7 @@ import { SkyColorpickerMessageType } from './colorpicker-message-type';
4
4
  */
5
5
  export interface SkyColorpickerMessage {
6
6
  /**
7
- * Specifies the message type.
7
+ * The message type.
8
8
  */
9
9
  type?: SkyColorpickerMessageType;
10
10
  }
@@ -7,35 +7,35 @@ import { SkyColorpickerRgba } from './colorpicker-rgba';
7
7
  */
8
8
  export interface SkyColorpickerOutput {
9
9
  /**
10
- * Specifies an HSLA text value for the selected color.
10
+ * The HSLA text value for the selected color.
11
11
  */
12
12
  hslaText: string;
13
13
  /**
14
- * Specifies an RGBA text value for the selected color.
14
+ * The RGBA text value for the selected color.
15
15
  */
16
16
  rgbaText: string;
17
17
  /**
18
- * Specifies a CMYK text value for the selected color.
18
+ * The CMYK text value for the selected color.
19
19
  */
20
20
  cmykText: string;
21
21
  /**
22
- * Specifies the HSVA values for the selected color.
22
+ * The HSVA values for the selected color.
23
23
  */
24
24
  hsva: SkyColorpickerHsva;
25
25
  /**
26
- * Specifies the RGBA values for the selected color.
26
+ * The RGBA values for the selected color.
27
27
  */
28
28
  rgba: SkyColorpickerRgba;
29
29
  /**
30
- * Specifies the HSLA values for the selected color.
30
+ * The HSLA values for the selected color.
31
31
  */
32
32
  hsla: SkyColorpickerHsla;
33
33
  /**
34
- * Specifies the CMYK values for the selected color.
34
+ * The CMYK values for the selected color.
35
35
  */
36
36
  cmyk: SkyColorpickerCmyk;
37
37
  /**
38
- * Specifies the hex value for the selected color.
38
+ * The hex value for the selected color.
39
39
  */
40
40
  hex: string;
41
41
  }
@@ -1,22 +1,22 @@
1
1
  /**
2
- * Specifies colors as a combination of red, green, and blue with an alpha
3
- * channel that specifies the opacity of the color.
2
+ * Colors specified as a combination of red, green, and blue with an alpha
3
+ * channel to set the opacity.
4
4
  */
5
5
  export interface SkyColorpickerRgba {
6
6
  /**
7
- * Specifies the percentage of red to use.
7
+ * The percentage of red.
8
8
  */
9
9
  red: number;
10
10
  /**
11
- * Specifies the percentage of green to use.
11
+ * The percentage of green.
12
12
  */
13
13
  green: number;
14
14
  /**
15
- * Specifies the percentage of blue to use.
15
+ * The percentage of blue.
16
16
  */
17
17
  blue: number;
18
18
  /**
19
- * Specifies the alpha channel to set the opacity.
19
+ * The alpha channel to set the opacity.
20
20
  */
21
21
  alpha: number;
22
22
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/colorpicker",
3
- "version": "7.5.0",
3
+ "version": "7.6.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -44,12 +44,12 @@
44
44
  "@angular/core": "^14.2.11",
45
45
  "@angular/forms": "^14.2.11",
46
46
  "@angular/platform-browser": "^14.2.11",
47
- "@skyux-sdk/testing": "7.5.0",
48
- "@skyux/core": "7.5.0",
49
- "@skyux/forms": "7.5.0",
50
- "@skyux/i18n": "7.5.0",
51
- "@skyux/indicators": "7.5.0",
52
- "@skyux/theme": "7.5.0"
47
+ "@skyux-sdk/testing": "7.6.0",
48
+ "@skyux/core": "7.6.0",
49
+ "@skyux/forms": "7.6.0",
50
+ "@skyux/i18n": "7.6.0",
51
+ "@skyux/indicators": "7.6.0",
52
+ "@skyux/theme": "7.6.0"
53
53
  },
54
54
  "dependencies": {
55
55
  "tslib": "^2.3.1"