@public-ui/components 3.0.0-rc.3 → 3.0.0-rc.4

package/dist/kolibri/msg-0c13cf1c.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["transformObjectProperties","obj","Object","entries","reduce","acc","key","value","newKey","startsWith","slice","assign","validateMsg","component","objectObjectHandler","parseJson","e","watchValidator","isObject","_description","Set","defaultValue","_type","isMsgEmpty","msg","convertMsgToInternMsg","undefined","checkHasError","touched","hasValidMsg","Boolean","description","length","showMsg","type"],"sources":["src/utils/transformObjectProperties.ts","src/schema/props/msg.ts"],"sourcesContent":["/**\n * Transforms keys with leading underscores, keeping non-underscore keys unchanged.\n *\n * @template K The original key type\n * @returns Transformed key type\n */\ntype TransformKeys<K> = K extends `_${infer Rest}` ? Rest : K;\n\n/**\n * Transforms object properties by removing leading underscores from key names.\n *\n * This method is useful for converting objects from a naming convention with leading underscores\n * (often used for private or internal properties) to a standard naming format.\n *\n * @param obj The input object with potential underscore prefixes\n * @returns A new object with underscores removed from key names\n *\n * @example\n * // Converts object with underscore-prefixed keys\n * const input = { _name: 'John', _age: 30 };\n * const result = transformObjectProperties(input);\n * // result is { name: 'John', age: 30 }\n */\nexport function transformObjectProperties<T extends Record<string, unknown>>(\n\tobj: T,\n): {\n\t[K in keyof T as TransformKeys<K>]: T[K];\n} {\n\treturn Object.entries(obj).reduce(\n\t\t(acc, [key, value]) => {\n\t\t\tconst newKey = key.startsWith('_') ? key.slice(1) : key;\n\t\t\treturn {\n\t\t\t\t...acc,\n\t\t\t\t[newKey]: value,\n\t\t\t};\n\t\t},\n\t\t{} as {\n\t\t\t[K in keyof T as TransformKeys<K>]: T[K];\n\t\t},\n\t);\n}\n","import type { Generic } from 'adopted-style-sheets';\nimport type { AlertProps, InternalAlertProps } from '../components';\nimport type { Stringified } from '../types';\nimport { objectObjectHandler, parseJson, watchValidator } from '../utils';\nimport { isObject } from '../validators';\nimport { transformObjectProperties } from '../../utils/transformObjectProperties';\n\n/* types */\nexport type MsgPropType = AlertProps & {\n\t_description: string;\n};\n\nexport type InternMsgPropType = Partial<\n\tInternalAlertProps & {\n\t\tdescription: string;\n\t}\n>;\n\n/**\n * Defines the properties for a message rendered as Alert component.\n */\nexport type PropMsg = {\n\tmsg: MsgPropType;\n};\n\n/* validator */\nexport const validateMsg = (component: Generic.Element.Component, value?: Stringified<MsgPropType>): void => {\n\tobjectObjectHandler(value, () => {\n\t\ttry {\n\t\t\tvalue = parseJson<MsgPropType>(value);\n\t\t\t// eslint-disable-next-line no-empty\n\t\t} catch (e) {\n\t\t\t// value keeps original value\n\t\t}\n\t\twatchValidator<MsgPropType>(\n\t\t\tcomponent,\n\t\t\t`_msg`,\n\t\t\t(value) => isObject(value) && typeof value?._description === 'string',\n\t\t\tnew Set(['MsgPropType']),\n\t\t\tvalue as MsgPropType,\n\t\t\t{\n\t\t\t\tdefaultValue: {\n\t\t\t\t\t_description: '',\n\t\t\t\t\t_type: 'error',\n\t\t\t\t},\n\t\t\t},\n\t\t);\n\t});\n};\n\nexport function isMsgEmpty(msg?: MsgPropType): boolean {\n\tif (!msg) {\n\t\treturn true;\n\t}\n\n\treturn msg._type === 'error' && !msg._description;\n}\n\nexport function convertMsgToInternMsg(msg?: MsgPropType): InternMsgPropType | undefined {\n\tif (!msg || isMsgEmpty(msg)) {\n\t\treturn undefined;\n\t}\n\n\treturn transformObjectProperties(msg);\n}\n\nexport function checkHasError(msg?: InternMsgPropType, touched?: boolean): boolean {\n\t/**\n\t * We support 5 types of messages:\n\t * - default\n\t * - info\n\t * - success\n\t * - warning\n\t * - error\n\t *\n\t * The message is shown if:\n\t * - the message text is not an empty string\n\t * - we show only one message at a time\n\t * - by error messages the input must be touched\n\t */\n\tconst hasValidMsg = Boolean(msg?.description && msg?.description.length > 0);\n\tconst showMsg = hasValidMsg && (touched === true || msg?.type !== 'error');\n\n\treturn showMsg;\n}\n"],"mappings":";;;kHAuBgBA,EACfC,GAIA,OAAOC,OAAOC,QAAQF,GAAKG,QAC1B,CAACC,GAAMC,EAAKC,MACX,MAAMC,EAASF,EAAIG,WAAW,KAAOH,EAAII,MAAM,GAAKJ,EACpD,OAAAJ,OAAAS,OAAAT,OAAAS,OAAA,GACIN,GAAG,CACNG,CAACA,GAASD,GAAK,GAGjB,GAIF,C,MCdaK,EAAc,CAACC,EAAsCN,KACjEO,EAAoBP,GAAO,KAC1B,IACCA,EAAQQ,EAAuBR,E,CAE9B,MAAOS,G,CAGTC,EACCJ,EACA,QACCN,GAAUW,EAASX,WAAiBA,IAAK,MAALA,SAAK,SAALA,EAAOY,gBAAiB,UAC7D,IAAIC,IAAI,CAAC,gBACTb,EACA,CACCc,aAAc,CACbF,aAAc,GACdG,MAAO,UAGT,GACA,E,SAGaC,EAAWC,GAC1B,IAAKA,EAAK,CACT,OAAO,I,CAGR,OAAOA,EAAIF,QAAU,UAAYE,EAAIL,YACtC,C,SAEgBM,EAAsBD,GACrC,IAAKA,GAAOD,EAAWC,GAAM,CAC5B,OAAOE,S,CAGR,OAAO1B,EAA0BwB,EAClC,C,SAEgBG,EAAcH,EAAyBI,GActD,MAAMC,EAAcC,SAAQN,IAAG,MAAHA,SAAG,SAAHA,EAAKO,eAAeP,IAAG,MAAHA,SAAG,SAAHA,EAAKO,YAAYC,QAAS,GAC1E,MAAMC,EAAUJ,IAAgBD,IAAY,OAAQJ,IAAG,MAAHA,SAAG,SAAHA,EAAKU,QAAS,SAElE,OAAOD,CACR,Q","ignoreList":[]}

package/dist/types/components/symbol/component.d.ts

@@ -1,11 +0,0 @@
-import type { LabelPropType, SymbolAPI, SymbolStates } from '../../schema';
-import type { JSX } from '../../stencil-public-runtime';
-export declare class KolSymbol implements SymbolAPI {
-    render(): JSX.Element;
-    _label: LabelPropType;
-    _symbol: string;
-    state: SymbolStates;
-    validateLabel(value?: LabelPropType): void;
-    validateSymbol(value?: string): void;
-    componentWillLoad(): void;
-}

package/dist/types/schema/components/symbol.d.ts

@@ -1,12 +0,0 @@
-import type { Generic } from 'adopted-style-sheets';
-import type { PropLabel } from '../props';
-type RequiredProps = {
-    symbol: string;
-} & PropLabel;
-type OptionalProps = NonNullable<unknown>;
-type RequiredStates = RequiredProps;
-type OptionalStates = NonNullable<unknown>;
-export type SymbolProps = Generic.Element.Members<RequiredProps, OptionalProps>;
-export type SymbolStates = Generic.Element.Members<RequiredStates, OptionalStates>;
-export type SymbolAPI = Generic.Element.ComponentApi<RequiredProps, OptionalProps, RequiredStates, OptionalStates>;
-export {};

package/dist/types/schema/props/hide-error.d.ts

@@ -1,7 +0,0 @@
-import type { Generic } from 'adopted-style-sheets';
-import type { WatchBooleanOptions } from '../utils';
-export type HideErrorPropType = boolean;
-export type PropHideError = {
-    hideError: HideErrorPropType;
-};
-export declare const validateHideError: (component: Generic.Element.Component, value?: HideErrorPropType, options?: WatchBooleanOptions) => void;

package/doc/symbol.md

@@ -1,44 +0,0 @@
-# Symbol
-
-Die **Symbol**-Komponente ermöglicht das Rendern beliebiger Symbole mit steuerbarer Ausgabe durch den Screenreader.
-
-## Konstruktion
-
-### Code
-
-```html
-<kol-symbol _label="Slash" _symbol="/"></kol-symbol>
-```
-
-### Beispiel
-
-<kol-symbol _label="Slash" _symbol="/"></kol-symbol>
-
-## Verwendung
-
-Das eigentliche Symbol, welches am Bildschirm ausgegeben wird, wird über die Property **`_symbol`** übergeben. Der zugehörige Text, den der Screenreader vorliest, wird über das Attribut **`_label`** übergeben.
-
-<!--### Best practices
-
-### Anwendungsfälle-->
-
-## Barrierefreiheit
-
-## Links und Referenzen
-
-- <kol-link _href="https://www.deque.com/blog/dont-screen-readers-read-whats-screen-part-1-punctuation-typographic-symbols/" _target="_blank"></kol-link>
-
-<!-- Auto Generated Below -->
-
-
-## Properties
-
-| Property               | Attribute | Description                                                                                                     | Type     | Default     |
-| ---------------------- | --------- | --------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
-| `_label` _(required)_  | `_label`  | Sets the visible or semantic label of the component (e.g. Aria label, Label, Headline, Caption, Summary, etc.). | `string` | `undefined` |
-| `_symbol` _(required)_ | `_symbol` | Dieses Property gibt den String an der angezeigt werden soll.                                                   | `string` | `undefined` |
-
-
-----------------------------------------------
-
-