primevuelab 4.0.0-beta.4

package/metergroup/BaseMeterGroup.vue

@@ -0,0 +1,42 @@
+<script>
+import BaseComponent from '@primevuelab/core/basecomponent';
+import MeterGroupStyle from 'primevuelab/metergroup/style';
+
+export default {
+    name: 'MeterGroup',
+    extends: BaseComponent,
+    props: {
+        value: {
+            type: Array,
+            default: null
+        },
+        min: {
+            type: Number,
+            default: 0
+        },
+        max: {
+            type: Number,
+            default: 100
+        },
+        orientation: {
+            type: String,
+            default: 'horizontal'
+        },
+        labelPosition: {
+            type: String,
+            default: 'end'
+        },
+        labelOrientation: {
+            type: String,
+            default: 'horizontal'
+        }
+    },
+    style: MeterGroupStyle,
+    provide() {
+        return {
+            $pcMeterGroup: this,
+            $parentInstance: this
+        };
+    }
+};
+</script>

package/metergroup/MeterGroup.d.ts

@@ -0,0 +1,312 @@
+/**
+ *
+ * MeterGroup is a group of process status indicators.
+ *
+ * [Live Demo](https://primevuelab.org/metergroup)
+ *
+ * @module metergroup
+ *
+ */
+import { VNode } from 'vue';
+import { PassThroughOptions } from '../passthrough';
+import { DefineComponent, DesignToken, EmitFn, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
+
+export declare type MeterGroupPassThroughOptionType = MeterGroupPassThroughAttributes | ((options: MeterGroupPassThroughMethodOptions) => MeterGroupPassThroughAttributes | string) | string | null | undefined;
+
+/**
+ * Custom passthrough(pt) option method.
+ */
+export interface MeterGroupPassThroughMethodOptions {
+    /**
+     * Defines instance.
+     */
+    instance: any;
+    /**
+     * Defines valid properties.
+     */
+    props: MeterGroupProps;
+    /**
+     * Defines current inline state.
+     */
+    context: MeterGroupContext;
+    /**
+     * Defines valid attributes.
+     */
+    attrs: any;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
+    /**
+     * Defines passthrough(pt) options in global config.
+     */
+    global: object | undefined;
+}
+
+/**
+ * Custom passthrough(pt) options.
+ * @see {@link MeterGroupProps.pt}
+ */
+export interface MeterGroupPassThroughOptions {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: MeterGroupPassThroughOptionType;
+    /**
+     * Used to pass attributes to the meter container's DOM element.
+     */
+    meters?: MeterGroupPassThroughOptionType;
+    /**
+     * Used to pass attributes to the meter's DOM element.
+     */
+    meter?: MeterGroupPassThroughOptionType;
+    /**
+     * Used to pass attributes to the label list's DOM element.
+     */
+    labelList?: MeterGroupPassThroughOptionType;
+    /**
+     * Used to pass attributes to the label list item's DOM element.
+     */
+    label?: MeterGroupPassThroughOptionType;
+    /**
+     * Used to pass attributes to the label icon type's DOM element.
+     */
+    labelIcon?: MeterGroupPassThroughOptionType;
+    /**
+     * Used to pass attributes to the label list type's DOM element.
+     */
+    labelMarker?: MeterGroupPassThroughOptionType;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    labelText?: MeterGroupPassThroughOptionType;
+}
+
+/**
+ * Custom passthrough attributes for each DOM elements
+ */
+export interface MeterGroupPassThroughAttributes {
+    [key: string]: any;
+}
+
+/**
+ * Defines current options in MeterGroup component.
+ */
+export interface MeterGroupContext {
+    /**
+     * Current value of the meter item
+     */
+    value: MeterItem;
+    /**
+     * Current index of the meter item
+     */
+    index: number;
+}
+
+/**
+ * Defines valid properties of a meter item.
+ */
+export interface MeterItem {
+    /**
+     * Current label of the meter item.
+     */
+    label: string;
+    /**
+     * Current value of the meter item.
+     */
+    value: number;
+    /**
+     * Current color of the meter item.
+     */
+    color: string;
+    /**
+     * Current icon of the meter item.
+     */
+    icon: string;
+    /**
+     * Optional keys.
+     */
+    [key: string]: any;
+}
+
+/**
+ * Defines valid properties in MeterGroup component.
+ */
+export interface MeterGroupProps {
+    /**
+     * Current value of the metergroup.
+     */
+    value?: MeterItem[] | undefined;
+    /**
+     * Mininum boundary value.
+     * @defaultValue 0
+     */
+    min?: number | undefined;
+    /**
+     * Maximum boundary value.
+     * @defaultValue 100
+     */
+    max?: number | undefined;
+    /**
+     * Specifies the layout of the component, valid values are 'horizontal' and 'vertical'.
+     * @defaultValue horizontal
+     */
+    orientation?: 'horizontal' | 'vertical' | undefined;
+    /**
+     * Specifies the label position of the component, valid values are 'start' and 'end'.
+     * @defaultValue end
+     */
+    labelPosition?: 'start' | 'end' | undefined;
+    /**
+     * Specifies the label orientation of the component, valid values are 'horizontal' and 'vertical'.
+     * @defaultValue horizontal
+     */
+    labelOrientation?: 'horizontal' | 'vertical' | undefined;
+    /**
+     * It generates scoped CSS variables using design tokens for the component.
+     */
+    dt?: DesignToken<any>;
+    /**
+     * Used to pass attributes to DOM elements inside the component.
+     * @type {MeterGroupPassThroughOptions}
+     */
+    pt?: PassThrough<MeterGroupPassThroughOptions>;
+    /**
+     * Used to configure passthrough(pt) options of the component.
+     * @type {PassThroughOptions}
+     */
+    ptOptions?: PassThroughOptions;
+    /**
+     * When enabled, it removes component related styles in the core.
+     * @defaultValue false
+     */
+    unstyled?: boolean;
+}
+
+/**
+ * Defines valid slots in MeterGroup component.
+ */
+export interface MeterGroupSlots {
+    /**
+     * Custom label template.
+     */
+    label(scope: {
+        /**
+         * Current value of the component
+         */
+        value: MeterItem[];
+        /**
+         * Total percent of the metergroup items
+         */
+        totalPercent: number;
+        /**
+         * Array of sequential sum of values of metergroup items
+         */
+        percentages: number[];
+    }): VNode[];
+    /**
+     * Custom meter template.
+     */
+    meter(scope: {
+        /**
+         * Current value of the meter item
+         */
+        value: MeterItem;
+        /**
+         * Current index of the meter item
+         */
+        index: number;
+        /**
+         * Style class of the meter item
+         */
+        class: string;
+        /**
+         * Current orientation of the component
+         */
+        orientation: string;
+        /**
+         * Current width of the meter item
+         */
+        size: string;
+        /**
+         * Total percent of the metergroup items
+         */
+        totalPercent: number;
+    }): VNode[];
+    /**
+     * Custom icon template.
+     */
+    icon(scope: {
+        /**
+         * Current value of the component
+         */
+        value: MeterItem;
+        /**
+         * Style class of the icon
+         */
+        class: string;
+    }): VNode[];
+    /**
+     * Custom start template.
+     */
+    start(scope: {
+        /**
+         * Current value of the component
+         */
+        value: MeterItem[];
+        /**
+         * Total percent of the metergroup items
+         */
+        totalPercent: number;
+        /**
+         * Array of sequential sum of values of metergroup items
+         */
+        percentages: number[];
+    }): VNode[];
+    /**
+     * Custom end template.
+     */
+    end(scope: {
+        /**
+         * Current value of the component
+         */
+        value: MeterItem[];
+        /**
+         * Total percent of the metergroup items
+         */
+        totalPercent: number;
+        /**
+         * Array of sequential sum of values of metergroup items
+         */
+        percentages: number[];
+    }): VNode[];
+}
+
+/**
+ * Defines valid emits in MeterGroup component.
+ */
+export interface MeterGroupEmitsOptions {}
+
+export declare type MeterGroupEmits = EmitFn<MeterGroupEmitsOptions>;
+
+/**
+ * **primevuelab - MeterGroup**
+ *
+ * _MeterGroup is a group of process status indicators._
+ *
+ * [Live Demo](https://www.primevuelab.org/metergroup/)
+ * --- ---
+ * ![primevuelab](https://primefaces.org/cdn/primevuelab/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
+declare const MeterGroup: DefineComponent<MeterGroupProps, MeterGroupSlots, MeterGroupEmits>;
+
+declare module 'vue' {
+    export interface GlobalComponents {
+        MeterGroup: GlobalComponentConstructor<MeterGroupProps, MeterGroupSlots, MeterGroupEmits>;
+    }
+}
+
+export default MeterGroup;

package/metergroup/MeterGroup.vue

@@ -0,0 +1,74 @@
+<template>
+    <div :class="cx('root')" role="meter" :aria-valuemin="min" :aria-valuemax="max" :aria-valuenow="totalPercent" v-bind="ptmi('root')">
+        <slot v-if="labelPosition === 'start'" name="label" :value="value" :totalPercent="totalPercent" :percentages="percentages">
+            <MeterGroupLabel :value="value" :labelPosition="labelPosition" :labelOrientation="labelOrientation" :unstyled="unstyled" :pt="pt" />
+        </slot>
+        <slot name="start" :value="value" :totalPercent="totalPercent" :percentages="percentages" />
+        <div :class="cx('meters')" v-bind="ptm('meters')">
+            <template v-for="(val, index) in value" :key="index">
+                <slot name="meter" :value="val" :index="index" :class="cx('meter')" :orientation="orientation" :size="percentValue(val.value)" :totalPercent="totalPercent">
+                    <span v-if="percent(val.value)" :class="cx('meter')" :style="meterCalculatedStyles(val)" v-bind="getPTOptions('meter', val, index)" />
+                </slot>
+            </template>
+        </div>
+        <slot name="end" :value="value" :totalPercent="totalPercent" :percentages="percentages" />
+        <slot v-if="labelPosition === 'end'" name="label" :value="value" :totalPercent="totalPercent" :percentages="percentages">
+            <MeterGroupLabel :value="value" :labelPosition="labelPosition" :labelOrientation="labelOrientation" :unstyled="unstyled" :pt="pt" />
+        </slot>
+    </div>
+</template>
+
+<script>
+import BaseMeterGroup from './BaseMeterGroup.vue';
+import MeterGroupLabel from './MeterGroupLabel.vue';
+
+export default {
+    name: 'MeterGroup',
+    extends: BaseMeterGroup,
+    inheritAttrs: false,
+    methods: {
+        getPTOptions(key, value, index) {
+            return this.ptm(key, {
+                context: {
+                    value,
+                    index
+                }
+            });
+        },
+        percent(meter = 0) {
+            const percentOfItem = ((meter - this.min) / (this.max - this.min)) * 100;
+
+            return Math.round(Math.max(0, Math.min(100, percentOfItem)));
+        },
+        percentValue(meter) {
+            return this.percent(meter) + '%';
+        },
+        meterCalculatedStyles(val) {
+            return {
+                backgroundColor: val.color,
+                width: this.orientation === 'horizontal' && this.percentValue(val.value),
+                height: this.orientation === 'vertical' && this.percentValue(val.value)
+            };
+        }
+    },
+    computed: {
+        totalPercent() {
+            return this.percent(this.value.reduce((total, val) => total + val.value, 0));
+        },
+        percentages() {
+            let sum = 0;
+            const sumsArray = [];
+
+            this.value.forEach((item) => {
+                sum += item.value;
+                sumsArray.push(sum);
+            });
+
+            return sumsArray;
+        }
+    },
+    components: {
+        MeterGroupLabel
+    }
+};
+</script>

package/metergroup/MeterGroupLabel.vue

@@ -0,0 +1,36 @@
+<template>
+    <ol :class="cx('labelList')" v-bind="ptm('labelList')">
+        <li v-for="(val, index) in value" :key="index + '_label'" :class="cx('label')" v-bind="ptm('label')">
+            <slot name="icon" :value="val" :class="cx('labelIcon')">
+                <i v-if="val.icon" :class="[val.icon, cx('labelIcon')]" :style="{ color: val.color }" v-bind="ptm('labelIcon')" />
+                <span v-else :class="cx('labelMarker')" :style="{ backgroundColor: val.color }" v-bind="ptm('labelMarker')" />
+            </slot>
+            <span :class="cx('labelText')" v-bind="ptm('labelText')">{{ val.label }} ({{ $parentInstance.percentValue(val.value) }})</span>
+        </li>
+    </ol>
+</template>
+
+<script>
+import BaseComponent from '@primevuelab/core/basecomponent';
+
+export default {
+    name: 'MeterGroupLabel',
+    hostName: 'MeterGroup',
+    extends: BaseComponent,
+    inheritAttrs: false,
+    props: {
+        value: {
+            type: Array,
+            default: null
+        },
+        labelPosition: {
+            type: String,
+            default: 'end'
+        },
+        labelOrientation: {
+            type: String,
+            default: 'horizontal'
+        }
+    }
+};
+</script>

package/metergroup/metergroup.mjs

@@ -0,0 +1,218 @@
+import BaseComponent from '@primevuelab/core/basecomponent';
+import MeterGroupStyle from 'primevuelab/metergroup/style';
+import { openBlock, createElementBlock, mergeProps, Fragment, renderList, renderSlot, normalizeClass, createElementVNode, toDisplayString, resolveComponent, createVNode, createCommentVNode } from 'vue';
+
+var script$2 = {
+  name: 'MeterGroup',
+  "extends": BaseComponent,
+  props: {
+    value: {
+      type: Array,
+      "default": null
+    },
+    min: {
+      type: Number,
+      "default": 0
+    },
+    max: {
+      type: Number,
+      "default": 100
+    },
+    orientation: {
+      type: String,
+      "default": 'horizontal'
+    },
+    labelPosition: {
+      type: String,
+      "default": 'end'
+    },
+    labelOrientation: {
+      type: String,
+      "default": 'horizontal'
+    }
+  },
+  style: MeterGroupStyle,
+  provide: function provide() {
+    return {
+      $pcMeterGroup: this,
+      $parentInstance: this
+    };
+  }
+};
+
+var script$1 = {
+  name: 'MeterGroupLabel',
+  hostName: 'MeterGroup',
+  "extends": BaseComponent,
+  inheritAttrs: false,
+  props: {
+    value: {
+      type: Array,
+      "default": null
+    },
+    labelPosition: {
+      type: String,
+      "default": 'end'
+    },
+    labelOrientation: {
+      type: String,
+      "default": 'horizontal'
+    }
+  }
+};
+
+function render$1(_ctx, _cache, $props, $setup, $data, $options) {
+  return openBlock(), createElementBlock("ol", mergeProps({
+    "class": _ctx.cx('labelList')
+  }, _ctx.ptm('labelList')), [(openBlock(true), createElementBlock(Fragment, null, renderList($props.value, function (val, index) {
+    return openBlock(), createElementBlock("li", mergeProps({
+      key: index + '_label',
+      "class": _ctx.cx('label'),
+      ref_for: true
+    }, _ctx.ptm('label')), [renderSlot(_ctx.$slots, "icon", {
+      value: val,
+      "class": normalizeClass(_ctx.cx('labelIcon'))
+    }, function () {
+      return [val.icon ? (openBlock(), createElementBlock("i", mergeProps({
+        key: 0,
+        "class": [val.icon, _ctx.cx('labelIcon')],
+        style: {
+          color: val.color
+        },
+        ref_for: true
+      }, _ctx.ptm('labelIcon')), null, 16)) : (openBlock(), createElementBlock("span", mergeProps({
+        key: 1,
+        "class": _ctx.cx('labelMarker'),
+        style: {
+          backgroundColor: val.color
+        },
+        ref_for: true
+      }, _ctx.ptm('labelMarker')), null, 16))];
+    }), createElementVNode("span", mergeProps({
+      "class": _ctx.cx('labelText'),
+      ref_for: true
+    }, _ctx.ptm('labelText')), toDisplayString(val.label) + " (" + toDisplayString(_ctx.$parentInstance.percentValue(val.value)) + ")", 17)], 16);
+  }), 128))], 16);
+}
+
+script$1.render = render$1;
+
+var script = {
+  name: 'MeterGroup',
+  "extends": script$2,
+  inheritAttrs: false,
+  methods: {
+    getPTOptions: function getPTOptions(key, value, index) {
+      return this.ptm(key, {
+        context: {
+          value: value,
+          index: index
+        }
+      });
+    },
+    percent: function percent() {
+      var meter = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+      var percentOfItem = (meter - this.min) / (this.max - this.min) * 100;
+      return Math.round(Math.max(0, Math.min(100, percentOfItem)));
+    },
+    percentValue: function percentValue(meter) {
+      return this.percent(meter) + '%';
+    },
+    meterCalculatedStyles: function meterCalculatedStyles(val) {
+      return {
+        backgroundColor: val.color,
+        width: this.orientation === 'horizontal' && this.percentValue(val.value),
+        height: this.orientation === 'vertical' && this.percentValue(val.value)
+      };
+    }
+  },
+  computed: {
+    totalPercent: function totalPercent() {
+      return this.percent(this.value.reduce(function (total, val) {
+        return total + val.value;
+      }, 0));
+    },
+    percentages: function percentages() {
+      var sum = 0;
+      var sumsArray = [];
+      this.value.forEach(function (item) {
+        sum += item.value;
+        sumsArray.push(sum);
+      });
+      return sumsArray;
+    }
+  },
+  components: {
+    MeterGroupLabel: script$1
+  }
+};
+
+var _hoisted_1 = ["aria-valuemin", "aria-valuemax", "aria-valuenow"];
+function render(_ctx, _cache, $props, $setup, $data, $options) {
+  var _component_MeterGroupLabel = resolveComponent("MeterGroupLabel");
+  return openBlock(), createElementBlock("div", mergeProps({
+    "class": _ctx.cx('root'),
+    role: "meter",
+    "aria-valuemin": _ctx.min,
+    "aria-valuemax": _ctx.max,
+    "aria-valuenow": $options.totalPercent
+  }, _ctx.ptmi('root')), [_ctx.labelPosition === 'start' ? renderSlot(_ctx.$slots, "label", {
+    key: 0,
+    value: _ctx.value,
+    totalPercent: $options.totalPercent,
+    percentages: $options.percentages
+  }, function () {
+    return [createVNode(_component_MeterGroupLabel, {
+      value: _ctx.value,
+      labelPosition: _ctx.labelPosition,
+      labelOrientation: _ctx.labelOrientation,
+      unstyled: _ctx.unstyled,
+      pt: _ctx.pt
+    }, null, 8, ["value", "labelPosition", "labelOrientation", "unstyled", "pt"])];
+  }) : createCommentVNode("", true), renderSlot(_ctx.$slots, "start", {
+    value: _ctx.value,
+    totalPercent: $options.totalPercent,
+    percentages: $options.percentages
+  }), createElementVNode("div", mergeProps({
+    "class": _ctx.cx('meters')
+  }, _ctx.ptm('meters')), [(openBlock(true), createElementBlock(Fragment, null, renderList(_ctx.value, function (val, index) {
+    return renderSlot(_ctx.$slots, "meter", {
+      key: index,
+      value: val,
+      index: index,
+      "class": normalizeClass(_ctx.cx('meter')),
+      orientation: _ctx.orientation,
+      size: $options.percentValue(val.value),
+      totalPercent: $options.totalPercent
+    }, function () {
+      return [$options.percent(val.value) ? (openBlock(), createElementBlock("span", mergeProps({
+        key: 0,
+        "class": _ctx.cx('meter'),
+        style: $options.meterCalculatedStyles(val),
+        ref_for: true
+      }, $options.getPTOptions('meter', val, index)), null, 16)) : createCommentVNode("", true)];
+    });
+  }), 128))], 16), renderSlot(_ctx.$slots, "end", {
+    value: _ctx.value,
+    totalPercent: $options.totalPercent,
+    percentages: $options.percentages
+  }), _ctx.labelPosition === 'end' ? renderSlot(_ctx.$slots, "label", {
+    key: 1,
+    value: _ctx.value,
+    totalPercent: $options.totalPercent,
+    percentages: $options.percentages
+  }, function () {
+    return [createVNode(_component_MeterGroupLabel, {
+      value: _ctx.value,
+      labelPosition: _ctx.labelPosition,
+      labelOrientation: _ctx.labelOrientation,
+      unstyled: _ctx.unstyled,
+      pt: _ctx.pt
+    }, null, 8, ["value", "labelPosition", "labelOrientation", "unstyled", "pt"])];
+  }) : createCommentVNode("", true)], 16, _hoisted_1);
+}
+
+script.render = render;
+
+export { script as default };
+//# sourceMappingURL=metergroup.mjs.map