@qoretechnologies/reqraft 0.10.64 → 0.10.65-pr.137.g62fcecc

package/dist/components/form/fields/color/Color.d.ts

@@ -1,21 +1,108 @@
-import { SketchPickerProps } from 'react-color';
-export interface IColorFormFieldProps extends Omit<SketchPickerProps, 'onChange' | 'onChangeComplete'> {
-    value?: {
-        r: number;
-        g: number;
-        b: number;
-        a?: number;
-    };
-    onChange?: (value: {
-        r: number;
-        g: number;
-        b: number;
-        a: number;
-    }) => void;
+import { RgbaColor } from '@uiw/color-convert';
+/** The color an `rgbcolor` field stores: red, green and blue from 0 to 255, alpha from 0 to 1. */
+export interface IColorFormFieldValue {
+    r: number;
+    g: number;
+    b: number;
+    a?: number;
+}
+/**
+ * What the color field reads as a color (qorus#646): a stored color, `{ r, g, b, a? }`, or a value stored the wrong
+ * way, which it still reads so it can show it and store it right - a hex code (3, 4, 6 or 8 digits, with or without
+ * its `#`), `{ hex }` (with an opacity beside it), or a color with fields beside its own (react-color stored a
+ * `hex`). Only the first is a stored color (`isStoredColor`); the field stores that shape whenever it edits any of
+ * them, even when the edit leaves the color as it was. A host passes the value as it is stored, not converted.
+ */
+export type TColorFormFieldInput = IColorFormFieldValue | (IColorFormFieldValue & Record<string, unknown>) | {
+    hex: string;
+    a?: number;
+} | string;
+/** A color offered as a swatch: a hex color, or one with a name to read it by. */
+export type TColorPreset = string | {
+    color: string;
+    title?: string;
+};
+/**
+ * The words of the color field. A host that translates its interface passes its own; English where it
+ * does not. A text that holds a value is a function of it, so a host keeps its language's word order.
+ */
+export interface IColorFormFieldLabels {
+    hex: string;
+    red: string;
+    green: string;
+    blue: string;
+    opacity: string;
+    /** The square in which the color's strength and brightness are chosen. */
+    area: string;
+    hue: string;
+    /** What the preview says of the color, for a screen reader. */
+    preview: (hex: string, opacityPercent: number) => string;
+    /** What the preview says when the field holds no color yet. */
+    noColor: string;
+    /** The button that shows and hides what the controls mean. */
+    help: string;
+    helpArea: string;
+    helpHex: string;
+    helpChannels: string;
+    helpOpacity: string;
+    /** A swatch's name, for a screen reader: the color it picks. */
+    swatch: (title: string) => string;
+    /** Characters typed into a hex code that cannot be in one. */
+    notHex: (characters: string) => string;
+    /** Characters typed into a number that cannot be in one. */
+    notDigits: (characters: string, field: string) => string;
+    /** A hex code too long to be one. */
+    hexTooLong: string;
+    /** A hex code of the wrong length. */
+    hexLength: (text: string) => string;
+    /** A hex code left empty. */
+    hexEmpty: string;
+    /** A number past its field's range. */
+    outOfRange: (field: string, max: number) => string;
+    /** A number field left empty. */
+    empty: (field: string, max: number) => string;
+}
+export declare const DEFAULT_COLOR_FORM_FIELD_LABELS: IColorFormFieldLabels;
+/** The colors offered as swatches when a host offers none of its own. */
+export declare const DEFAULT_COLOR_PRESETS: TColorPreset[];
+export interface IColorFormFieldProps {
+    /** The value as it is stored: see `TColorFormFieldInput`. */
+    value?: TColorFormFieldInput;
+    onChange?: (value: Required<IColorFormFieldValue>) => void;
     disabled?: boolean;
     readOnly?: boolean;
+    /** Leave out the transparency slider and keep the stored transparency (the default). */
+    disableAlpha?: boolean;
+    /** The swatches offered, or `false` for none. */
+    presetColors?: false | TColorPreset[];
+    className?: string;
+    /** The field's words, for a host that translates them. */
+    labels?: Partial<IColorFormFieldLabels>;
 }
-export declare const StyledSketchPicker: any;
-export declare const ColorFormField: ({ value, onChange, disabled, readOnly, ...rest }: IColorFormFieldProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A stored color as red, green, blue and alpha: `{ r, g, b, a? }` as the field stores it, or a hex color,
+ * bare or as `{ hex }`, as a value written by hand or by another client can be. Undefined when it is none
+ * of these. A channel past its range is brought into it, so what is shown, and stored from it, is a color.
+ * Only `{ r, g, b, a? }` is a stored color (`isStoredColor`); the others are read so they can be seen and fixed.
+ */
+export declare const colorToRgba: (value: unknown) => RgbaColor | undefined;
+/** A finger's target: the smallest a control should be on a touch screen. */
+export declare const TAP_TARGET_PX = 44;
+export declare const StyledColorField: any;
+/**
+ * The `rgbcolor` field: a color picker that stores `{ r, g, b, a }`.
+ *
+ * It is drawn from the `@uiw` picker's parts - the color square, the hue bar and the opacity bar - and
+ * around them the field's own: a preview of the color, its hex code and its red, green, blue (and
+ * opacity) as labelled inputs that take only what a color can be, a "What do these mean?" help, and
+ * swatches. On a touch screen every target is a finger's size.
+ *
+ * The picker works in hue, saturation and value, and a stored color is red, green and blue. A color the
+ * picker sent comes back as the field's value, and turned back into hue it can lose what the picker had:
+ * a grey has no hue, so moving the saturation to a grey would throw the hue bar back to red. So the color
+ * the picker last showed is kept with the color it sent, and only a value that changed somewhere else is
+ * converted.
+ */
+export declare const ColorFormField: ({ value, onChange, disabled, readOnly, disableAlpha, presetColors, className, labels, }: IColorFormFieldProps) => import("react/jsx-runtime").JSX.Element;
 export default ColorFormField;
 //# sourceMappingURL=Color.d.ts.map

package/dist/components/form/fields/color/Color.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Color.d.ts","sourceRoot":"","sources":["../../../../../src/components/form/fields/color/Color.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAgB,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAG9D,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAAC,iBAAiB,EAAE,UAAU,GAAG,kBAAkB,CAAC;IACpG,KAAK,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxD,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,eAAO,MAAM,kBAAkB,KAqB9B,CAAC;AAEF,eAAO,MAAM,cAAc,qDAAsD,oBAAoB,4CAUpG,CAAC;AAEF,eAAe,cAAc,CAAC"}
+{"version":3,"file":"Color.d.ts","sourceRoot":"","sources":["../../../../../src/components/form/fields/color/Color.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAyB,SAAS,EAAyB,MAAM,oBAAoB,CAAC;AAuB7F,kGAAkG;AAClG,MAAM,WAAW,oBAAoB;IACnC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,GACpB,CAAC,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAChD;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3B,MAAM,CAAC;AAEX,kFAAkF;AAClF,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtE;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,KAAK,MAAM,CAAC;IACzD,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IAKb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,gEAAgE;IAChE,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IAClC,8DAA8D;IAC9D,MAAM,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC,4DAA4D;IAC5D,SAAS,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IACzD,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACpC,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACnD,iCAAiC;IACjC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;CAC/C;AAcD,eAAO,MAAM,+BAA+B,EAAE,qBA8B7C,CAAC;AAEF,yEAAyE;AACzE,eAAO,MAAM,qBAAqB,EAAE,YAAY,EAgB/C,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACnC,6DAA6D;IAC7D,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,oBAAoB,CAAC,KAAK,IAAI,CAAC;IAC3D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,wFAAwF;IACxF,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iDAAiD;IACjD,YAAY,CAAC,EAAE,KAAK,GAAG,YAAY,EAAE,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACzC;AAuBD;;;;;GAKG;AACH,eAAO,MAAM,WAAW,UAAW,OAAO,KAAG,SAAS,GAAG,SAoBxD,CAAC;AAOF,6EAA6E;AAC7E,eAAO,MAAM,aAAa,KAAK,CAAC;AA4DhC,eAAO,MAAM,gBAAgB,KAS5B,CAAC;AAkOF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,4FASxB,oBAAoB,4CA+atB,CAAC;AAEF,eAAe,cAAc,CAAC"}