plmt-constructor-sdk 0.17.9 → 0.17.11

package/__internal__/view-settings.d.ts

@@ -1,4 +1,5 @@
 import { Text, ViewSettingsItem } from '../config';
+import type { AffixContent } from '../view-settings-params';
 export declare enum ViewSettingsItemType {
     Input = "text",
     Checkbox = "checkbox",
@@ -68,6 +69,8 @@ export interface ViewSettingsItemValue {
     }[];
     span?: number;
     invalidChars?: string[];
+    prefix?: AffixContent;
+    suffix?: AffixContent;
 }
 export declare const viewSettingsItemValue = "418d9556-a046-4623-be0b-4f4f69ccb783";
 export declare function viewSettingsExtract(viewSettings: ViewSettingsItem[]): ViewSettingsItemValue[];

package/__internal__/view-settings.js

@@ -59,6 +59,8 @@ function viewSettingsExtract(viewSettings) {
         options: item.options || [],
         span: getSpan(item.span),
         invalidChars: item.invalidChars,
+        prefix: item.prefix,
+        suffix: item.suffix,
     }));
 }
 exports.viewSettingsExtract = viewSettingsExtract;

package/config.d.ts

@@ -7,7 +7,8 @@
 import { ColumnType } from './data';
 import { DataSettings as WidgetDataSettings, DataSettingsMap as WidgetDataSettingsMap, ViewSettings } from './widget';
 import { configDataBlock_Server } from './__internal__/config';
-import { TooltipSettings, InputType, viewSettingsItemValue } from './__internal__/view-settings';
+import { viewSettingsItemValue } from './__internal__/view-settings';
+import type { CheckboxParams, ColorPickerParams, InputParams, RadioParams, SelectParams, TextAreaParams } from './view-settings-params';
 export declare enum DataQueryMethod {
     Table = "table",
     PivotTable = "pivot",
@@ -150,62 +151,12 @@ export declare class ViewSettingsItem {
     private [viewSettingsItemValue];
     constructor(_: symbol);
 }
-export declare function input(params: {
-    key: string;
-    label: Text;
-    span?: number;
-    placeholder?: Text;
-    defaultValue?: string;
-    tooltip?: TooltipSettings;
-    disabled?: true;
-    clearable?: true;
-    flex?: true;
-    id?: number;
-    typeInput?: InputType;
-    invalidChars?: string[];
-}): ViewSettingsItem;
-export declare function textArea(params: {
-    key: string;
-    label: Text;
-    span?: number;
-    placeholder?: Text;
-    defaultValue?: string;
-}): ViewSettingsItem;
-export declare function checkbox(params: {
-    key: string;
-    label: Text;
-    span?: number;
-    defaultValue?: boolean;
-    tooltip?: TooltipSettings;
-}): ViewSettingsItem;
-export declare function radio(params: {
-    key: string;
-    label: Text;
-    options: {
-        label: Text;
-        value: string;
-    }[];
-    span?: number;
-    defaultValue?: string;
-}): ViewSettingsItem;
-export declare function select(params: {
-    key: string;
-    label: Text;
-    options: {
-        label: Text;
-        value: string;
-    }[];
-    span?: number;
-    defaultValue?: string;
-    tooltip?: TooltipSettings;
-}): ViewSettingsItem;
-export declare function colorPicker(params: {
-    key: string;
-    label: Text;
-    span?: number;
-    defaultValue?: string;
-    tooltip?: TooltipSettings;
-}): ViewSettingsItem;
+export declare function input(params: InputParams): ViewSettingsItem;
+export declare function textArea(params: TextAreaParams): ViewSettingsItem;
+export declare function checkbox(params: CheckboxParams): ViewSettingsItem;
+export declare function radio(params: RadioParams): ViewSettingsItem;
+export declare function select(params: SelectParams): ViewSettingsItem;
+export declare function colorPicker(params: ColorPickerParams): ViewSettingsItem;
 /**
  * Создаёт collapsible секцию в панели настроек
  */

package/index.d.ts

@@ -1,3 +1,4 @@
 export * from './declare';
 export * from './widget';
 export * from './conditional-format';
+export * from './view-settings-params';

package/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./declare"), exports);
 __exportStar(require("./widget"), exports);
 __exportStar(require("./conditional-format"), exports);
+__exportStar(require("./view-settings-params"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "plmt-constructor-sdk",
-    "version": "0.17.9",
+    "version": "0.17.11",
     "description": "Набор инструментов для создания виджетов.",
     "dependencies": {
         "logical-not": "^1.0.9"

package/view-settings-params.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Типы параметров элементов панели настроек виджета
+ *
+ * @packageDocumentation
+ * @module Настройки отображения
+ */
+import type { Text } from './config';
+import type { InputType, TooltipSettings } from './__internal__/view-settings';
+export declare type IconSettings = string | {
+    icon: string;
+    library: string;
+};
+export interface HtmlSettings {
+    type: 'html';
+    html: string;
+}
+export declare type BadgeVariant = 'primary' | 'success' | 'neutral' | 'warning' | 'danger';
+export declare type BadgeSize = 'x-small' | 'small' | 'medium' | 'large';
+export interface BadgeSettings extends AffixOptions {
+    type: 'badge';
+    size?: BadgeSize;
+    pill?: true;
+    variant?: BadgeVariant;
+    light?: true;
+    content?: Text;
+}
+export declare type AffixContent = IconSettings | BadgeSettings | HtmlSettings;
+export interface AffixOptions {
+    prefix?: AffixContent;
+    suffix?: AffixContent;
+}
+export declare type ViewSettingsOption<T extends any = {}> = {
+    label: Text;
+    value: string;
+} & T;
+export interface ViewSettingsBaseParams extends AffixOptions {
+    key: string;
+    label: Text;
+    span?: number;
+    defaultValue?: string;
+    placeholder?: Text;
+    tooltip?: TooltipSettings;
+}
+export interface InputParams extends ViewSettingsBaseParams {
+    disabled?: true;
+    clearable?: true;
+    flex?: true;
+    id?: number;
+    typeInput?: InputType;
+    invalidChars?: string[];
+}
+export declare type TextAreaParams = ViewSettingsBaseParams;
+export interface CheckboxParams extends Omit<ViewSettingsBaseParams, 'defaultValue'> {
+    defaultValue?: boolean;
+}
+export interface RadioParams extends ViewSettingsBaseParams {
+    options: ViewSettingsOption[];
+}
+export interface SelectParams extends ViewSettingsBaseParams {
+    options: ViewSettingsOption<AffixOptions>[];
+}
+export declare type ColorPickerParams = ViewSettingsBaseParams;

package/view-settings-params.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Типы параметров элементов панели настроек виджета
+ *
+ * @packageDocumentation
+ * @module Настройки отображения
+ */
+Object.defineProperty(exports, "__esModule", { value: true });