@vc-shell/framework 1.0.188 → 1.0.190

package/shared/modules/dynamic/components/fields/storybook/InputField.stories.ts

@@ -0,0 +1,298 @@
+import { Meta, StoryFn } from "@storybook/vue3";
+import { InputSchema } from "../../..";
+import { SchemaBaseArgTypes } from "./common/args";
+import page from "./pages/DynamicRender";
+import { template, templateWithVisibilityToggle } from "./common/templates";
+import { reactive, ref } from "vue";
+
+export default {
+  title: "DynamicViews/molecules/VcInput",
+  component: page,
+  args: {
+    id: "inputFieldId",
+    component: "vc-input",
+    property: "mockedProperty",
+    variant: "text",
+  },
+  argTypes: {
+    ...SchemaBaseArgTypes,
+    component: {
+      description: "Component type.",
+      type: {
+        required: true,
+        name: "string",
+      },
+      table: {
+        type: {
+          summary: "vc-input",
+        },
+        defaultValue: {
+          summary: "vc-input",
+        },
+      },
+    },
+    variant: {
+      description: "Field variant.",
+      control: "radio",
+      options: ["number", "text", "password", "email", "tel", "url", "time", "date", "datetime-local"],
+      table: {
+        type: {
+          summary: "number | text | password | email | tel | url | time | date | datetime-local",
+        },
+        defaultValue: {
+          summary: "text",
+        },
+      },
+    },
+    clearable: {
+      description: "Whether the input is clearable or not.",
+      table: {
+        type: {
+          summary: "boolean",
+        },
+        defaultValue: {
+          summary: "false",
+        },
+      },
+    },
+    prepend: {
+      description: "Schema of component to be displayed before the input.",
+      table: {
+        type: {
+          summary: "ControlSchema",
+        },
+      },
+    },
+    append: {
+      description: "Schema of component to be displayed after the input.",
+      table: {
+        type: {
+          summary: "ControlSchema",
+        },
+      },
+    },
+    appendInner: {
+      description: "Schema of component to be displayed inside the input after the value.",
+      table: {
+        type: {
+          summary: "ControlSchema",
+        },
+      },
+    },
+    prependInner: {
+      description: "Schema of component to be displayed inside the input before the value.",
+      table: {
+        type: {
+          summary: "ControlSchema",
+        },
+      },
+    },
+    maxlength: {
+      description: "Maximum number of characters that can be entered.",
+      control: "number",
+      table: {
+        type: {
+          summary: "number",
+        },
+        defaultValue: {
+          summary: 1024,
+        },
+      },
+    },
+  },
+  parameters: {
+    docs: {
+      canvas: {
+        sourceState: "none",
+      },
+    },
+  },
+} satisfies Meta<InputSchema>;
+
+export const Template: StoryFn<InputSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: "I am input field",
+      },
+    });
+    return { args, context };
+  },
+  template,
+});
+
+export const WithLabel = Template.bind({});
+WithLabel.args = {
+  label: "Input label",
+};
+
+export const WithTooltip = WithLabel.bind({});
+WithTooltip.args = {
+  label: "Input label",
+  tooltip: "Input tooltip",
+};
+
+export const WithPlaceholder = Template.bind({});
+WithPlaceholder.args = {
+  label: "Input label",
+  placeholder: "Input placeholder",
+};
+
+export const WithPrepend: StoryFn<InputSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: "I am input field",
+      },
+      scope: {
+        btnClick: () => alert("Button clicked!"),
+      },
+    });
+    return { args, context };
+  },
+  template,
+});
+WithPrepend.args = {
+  label: "Input label",
+  prepend: {
+    component: "vc-button",
+    id: "prependButtonId",
+    content: "Prepend",
+    method: "btnClick",
+  },
+};
+
+export const WithAppend = WithPrepend.bind({});
+WithAppend.args = {
+  label: "Input label",
+  append: {
+    component: "vc-button",
+    id: "appendButtonId",
+    content: "Append",
+    method: "btnClick",
+  },
+};
+
+export const WithPrependInner = WithPrepend.bind({});
+WithPrependInner.args = {
+  label: "Input label",
+  prependInner: {
+    component: "vc-button",
+    id: "prependInnerButtonId",
+    content: "Prepend Inner",
+    method: "btnClick",
+  },
+};
+
+export const WithAppendInner = WithPrepend.bind({});
+WithAppendInner.args = {
+  label: "Input label",
+  appendInner: {
+    component: "vc-button",
+    id: "appendInnerButtonId",
+    content: "Append Inner",
+    method: "btnClick",
+  },
+};
+
+export const WithClearable = Template.bind({});
+WithClearable.args = {
+  label: "Input label",
+  clearable: true,
+};
+
+export const WithDisabled: StoryFn<InputSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: "I am input field",
+      },
+      scope: {
+        disabledFn: true,
+      },
+    });
+    return { args, context };
+  },
+  template,
+});
+WithDisabled.args = {
+  label: "Input label",
+  disabled: { method: "disabledFn" },
+};
+
+export const WithVisibilityMethod: StoryFn<InputSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const isVisible = ref(false);
+    const toggle = () => {
+      isVisible.value = !isVisible.value;
+    };
+
+    const context = reactive({
+      item: {
+        mockedProperty: "I am input field",
+      },
+      scope: {
+        visibilityFn: isVisible,
+      },
+    });
+
+    return { args, context, toggle };
+  },
+  template: templateWithVisibilityToggle,
+});
+WithVisibilityMethod.args = {
+  label: "Input label",
+  visibility: { method: "visibilityFn" },
+};
+
+export const WithUpdateMethod: StoryFn<InputSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: "I am input field",
+      },
+      scope: {
+        updateFn: (value: string) => alert(`Value updated to: ${value}`),
+      },
+    });
+    return { args, context };
+  },
+  template,
+});
+WithUpdateMethod.args = {
+  label: "Input label",
+  update: { method: "updateFn" },
+};
+
+export const WithValidation: StoryFn<InputSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: undefined,
+      },
+      scope: {},
+    });
+    return { args, context };
+  },
+  template,
+});
+WithValidation.args = {
+  label: "Input label",
+  placeholder: "Enter a number",
+  rules: {
+    required: true,
+    numeric: true,
+  },
+};
+
+export const WithHorizontalSeparator = Template.bind({});
+WithHorizontalSeparator.args = {
+  label: "Input label",
+  horizontalSeparator: true,
+};

package/shared/modules/dynamic/components/fields/storybook/MultivalueField.stories.ts

@@ -0,0 +1,347 @@
+import { Meta, StoryFn, setup } from "@storybook/vue3";
+import { MultivalueSchema } from "../../..";
+import { SchemaBaseArgTypes } from "./common/args";
+import { template, templateWithVisibilityToggle } from "./common/templates";
+import page from "./pages/DynamicRender";
+import { computed, defineComponent, reactive, ref, watch } from "vue";
+import { VcIcon } from "../../../../../../ui/components/atoms/vc-icon";
+
+const customTemplateComponent = {
+  props: ["context", "slotName"],
+  template: `
+  <template v-if="slotName === 'option'">
+    <div class="tw-flex tw-flex-col">
+      <h2>ID - {{context.item.id}}</h2>
+      <p>Title - {{context.item.title}}</p>
+    </div>
+  </template>
+  <template v-else-if="slotName === 'selected-item'">
+    <div class="tw-flex tw-flex-row tw-gap-3 tw-items-center">
+      <VcIcon icon="fas fa-check" class="tw-text-green-500" />
+      {{ context.value }}
+      </div>
+  </template>
+  `,
+};
+
+setup((app) => {
+  app.component("CustomMultivalue", customTemplateComponent);
+});
+
+export default {
+  title: "DynamicViews/molecules/VcMultivalue",
+  component: page,
+  args: {
+    id: "multivalueFieldId",
+    component: "vc-multivalue",
+
+    property: "mockedProperty",
+  },
+  argTypes: {
+    ...SchemaBaseArgTypes,
+    component: {
+      description: "Component type.",
+      type: {
+        required: true,
+        name: "string",
+      },
+      table: {
+        type: {
+          summary: "vc-multivalue",
+        },
+        defaultValue: {
+          summary: "vc-multivalue",
+        },
+      },
+    },
+    optionValue: {
+      description: "Property which holds the `value`",
+      type: {
+        required: true,
+        name: "string",
+      },
+      control: "text",
+      table: {
+        type: {
+          summary: "string",
+        },
+        defaultValue: {
+          summary: "id",
+        },
+      },
+    },
+    optionLabel: {
+      description: "Property which holds the `label`",
+      type: {
+        required: true,
+        name: "string",
+      },
+      control: "text",
+      table: {
+        type: {
+          summary: "string",
+        },
+        defaultValue: {
+          summary: "title",
+        },
+      },
+    },
+    options: {
+      description: "Array with multivalue dictionary. Array should be defined in the blade `scope`.",
+      table: {
+        type: {
+          summary: "string",
+        },
+      },
+    },
+    multivalue: {
+      description: "Whether the select is multivalue or not.",
+      control: "boolean",
+      table: {
+        type: {
+          summary: "boolean",
+        },
+      },
+    },
+    variant: {
+      description: "Multivalue type",
+      control: "radio",
+      options: ["number", "text"],
+      table: {
+        type: {
+          summary: "number | text",
+        },
+        defaultValue: {
+          summary: "text",
+        },
+      },
+    },
+    customTemplate: {
+      description: `Name of custom template to display data in multivalue.
+        Component should be registered globally.
+        Supported slots:
+        \n1) \`selected-item\` - selected item
+        \n2) \`option\` - options in dropdown list
+        \nComponent should have the following props:
+        \n1) \`context\` - object with the following properties:
+        \n - \`item\` - selected item
+        \n - \`value\` - selected value
+        \n - \`remove\` - function to remove the option
+        \n2) \`slotName\` - name of the slot to render`,
+      table: {
+        type: {
+          summary: "{ component: string }",
+        },
+      },
+    },
+  },
+  parameters: {
+    docs: {
+      canvas: {
+        sourceState: "none",
+      },
+    },
+  },
+} satisfies Meta<MultivalueSchema>;
+
+export const Template: StoryFn<MultivalueSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: undefined,
+      },
+      scope: {},
+    });
+    return { args, context };
+  },
+  template,
+});
+Template.args = {
+  placeholder: "Write something and press Enter",
+};
+
+export const NumberInput: StoryFn<MultivalueSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: undefined,
+      },
+      scope: {},
+    });
+    return { args, context };
+  },
+  template,
+});
+NumberInput.args = {
+  variant: "number",
+  placeholder: "Write something and press Enter",
+};
+
+export const Multivalue: StoryFn<MultivalueSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: undefined,
+      },
+      scope: {
+        mockedOptionsArray: [
+          { id: "1", title: "Option 1" },
+          { id: "2", title: "Option 2" },
+          { id: "3", title: "Option 3" },
+        ],
+      },
+    });
+    return { args, context };
+  },
+  template,
+});
+Multivalue.args = {
+  multivalue: true,
+  options: "mockedOptionsArray",
+};
+
+export const CustomTemplate: StoryFn<MultivalueSchema> = (args) => ({
+  components: { page, VcIcon },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: [{ id: "1", title: "Option 1" }],
+      },
+      scope: {
+        mockedOptionsArray: [
+          { id: "1", title: "Option 1" },
+          { id: "2", title: "Option 2" },
+          { id: "3", title: "Option 3" },
+        ],
+      },
+    });
+    return { args, context };
+  },
+  template,
+});
+CustomTemplate.storyName = "Custom template for dropdown item and selected item";
+CustomTemplate.args = {
+  options: "mockedOptionsArray",
+  multivalue: true,
+  customTemplate: { component: "custom-multivalue" },
+};
+
+export const WithLabel: StoryFn<MultivalueSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: [],
+      },
+      scope: {},
+    });
+    return { args, context };
+  },
+  template,
+});
+
+WithLabel.args = {
+  label: "Input label",
+};
+
+export const WithValidation = WithLabel.bind({});
+WithValidation.args = {
+  label: "Input label",
+  placeholder: "Enter a number",
+  rules: {
+    required: true,
+  },
+};
+
+export const WithTooltip = WithLabel.bind({});
+
+WithTooltip.args = {
+  label: "Input label",
+  tooltip: "I am a tooltip",
+};
+
+export const WithDisabled: StoryFn<MultivalueSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: [],
+      },
+      scope: {
+        disabledFn: true,
+      },
+    });
+    return { args, context };
+  },
+  template,
+});
+WithDisabled.args = {
+  label: "Input label",
+  disabled: {
+    method: "disabledFn",
+  },
+};
+
+export const WithPlaceholder = WithLabel.bind({});
+WithPlaceholder.args = {
+  label: "Input label",
+  placeholder: "I am a placeholder",
+};
+
+export const WithVisibilityMethod: StoryFn<MultivalueSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const isVisible = ref(false);
+    const toggle = () => {
+      isVisible.value = !isVisible.value;
+    };
+
+    const context = reactive({
+      item: {
+        mockedProperty: [],
+      },
+      scope: {
+        visibilityFn: isVisible,
+      },
+    });
+    return { args, context, toggle };
+  },
+  template: templateWithVisibilityToggle,
+});
+WithVisibilityMethod.args = {
+  label: "Input label",
+  visibility: {
+    method: "visibilityFn",
+  },
+};
+
+export const WithUpdateMethod: StoryFn<MultivalueSchema> = (args) => ({
+  components: { page },
+  setup() {
+    const context = reactive({
+      item: {
+        mockedProperty: [],
+      },
+      scope: {
+        updateFn: (value: string) => alert(`Value updated to: ${JSON.stringify(value, null, 2)}`),
+      },
+    });
+    return { args, context };
+  },
+  template,
+});
+WithUpdateMethod.args = {
+  label: "Input label",
+  update: {
+    method: "updateFn",
+  },
+};
+
+export const WithHorizontalSeparator = Template.bind({});
+WithHorizontalSeparator.args = {
+  label: "Input label",
+  horizontalSeparator: true,
+};