vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Merge branch 'v4' of https://github.com/primefaces/primevue into v4

pull/5677/head
Cagatay Civici 2024-04-08 15:21:46 +03:00
parent cdd0cb38ac b1e99bbb4f
commit 1c49889005
12 changed files with 110 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/lib/autocomplete/AutoComplete.d.ts vendored
View File

@ -9,6 +9,7 @@
*/
import { TransitionProps, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ChipPassThroughOptions } from '../chip';
import { InputTextPassThroughOptions } from '../inputtext';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, DesignToken, GlobalComponentConstructor, HintedString, Nullable, PassThrough } from '../ts-helpers';
@ -156,9 +157,10 @@ export interface AutoCompletePassThroughOptions {
*/
token?: AutoCompletePassThroughOptionType;
/**
* Used to pass attributes to the token label's DOM element.
* Used to pass attributes to the Chip.
* @see {@link ChipPassThroughOptions}
*/
tokenLabel?: AutoCompletePassThroughOptionType;
tokenLabel?: ChipPassThroughOptions<AutoCompleteSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the remove token icon's DOM element.
*/

17
components/lib/autocomplete/AutoComplete.vue
View File

@ -45,7 +45,7 @@
>
<li
v-for="(option, i) of modelValue"
:key="i"
:key="`${i}_${getOptionLabel(option)}`"
:id="id + '_multiple_option_' + i"
:class="cx('token', { i })"
role="option"
@ -55,11 +55,12 @@
:aria-posinset="i + 1"
v-bind="ptm('token')"
>
<slot name="chip" :value="option">
<span :class="cx('tokenLabel')" v-bind="ptm('tokenLabel')">{{ getOptionLabel(option) }}</span>
</slot>
<slot name="removetokenicon" :class="cx('removeTokenIcon')" :index="i" :onClick="(event) => removeOption(event, i)" :removeCallback="(event) => removeOption(event, i)">
<component :is="removeTokenIcon ? 'span' : 'TimesCircleIcon'" :class="[cx('removeTokenIcon'), removeTokenIcon]" @click="removeOption($event, i)" aria-hidden="true" v-bind="ptm('removeTokenIcon')" />
<slot name="chip" :value="option" :index="i" :removeCallback="(event) => removeOption(event, i)">
<Chip :class="cx('tokenLabel')" :label="getOptionLabel(option)" :removeIcon="removeTokenIcon" removable @remove="removeOption($event, i)" :pt="ptm('tokenLabel')">
<template #removeicon>
<slot name="removetokenicon" :class="cx('removeTokenIcon')" :index="i" :removeCallback="(event) => removeOption(event, i)" />
</template>
</Chip>
</slot>
</li>
<li :class="cx('inputToken')" role="option" v-bind="ptm('inputToken')">
@ -182,9 +183,9 @@
</template>
<script>
import Chip from 'primevue/chip';
import ChevronDownIcon from 'primevue/icons/chevrondown';
import SpinnerIcon from 'primevue/icons/spinner';
import TimesCircleIcon from 'primevue/icons/timescircle';
import InputText from 'primevue/inputtext';
import OverlayEventBus from 'primevue/overlayeventbus';
import Portal from 'primevue/portal';
@ -968,7 +969,7 @@ export default {
Portal,
ChevronDownIcon,
SpinnerIcon,
TimesCircleIcon
Chip
},
directives: {
ripple: Ripple

18
components/lib/chip/Chip.d.ts vendored
View File

@ -12,12 +12,12 @@ import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, DesignToken, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type ChipPassThroughOptionType = ChipPassThroughAttributes | ((options: ChipPassThroughMethodOptions) => ChipPassThroughAttributes | string) | string | null | undefined;
export declare type ChipPassThroughOptionType<T = any> = ChipPassThroughAttributes | ((options: ChipPassThroughMethodOptions<T>) => ChipPassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface ChipPassThroughMethodOptions {
export interface ChipPassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -37,7 +37,7 @@ export interface ChipPassThroughMethodOptions {
/**
* Defines parent options.
*/
parent: any;
parent: T;
/**
* Defines passthrough(pt) options in global config.
*/
@ -48,27 +48,27 @@ export interface ChipPassThroughMethodOptions {
* Custom passthrough(pt) options.
* @see {@link ChipProps.pt}
*/
export interface ChipPassThroughOptions {
export interface ChipPassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: ChipPassThroughOptionType;
root?: ChipPassThroughOptionType<T>;
/**
* Used to pass attributes to the image's DOM element.
*/
image?: ChipPassThroughOptionType;
image?: ChipPassThroughOptionType<T>;
/**
* Used to pass attributes to the icon's DOM element.
*/
icon?: ChipPassThroughOptionType;
icon?: ChipPassThroughOptionType<T>;
/**
* Used to pass attributes to the label' DOM element.
*/
label?: ChipPassThroughOptionType;
label?: ChipPassThroughOptionType<T>;
/**
* Used to pass attributes to the removeIcon's DOM element.
*/
removeIcon?: ChipPassThroughOptionType;
removeIcon?: ChipPassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

20
components/lib/chips/Chips.d.ts vendored
View File

@ -9,6 +9,7 @@
*/
import { InputHTMLAttributes, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ChipPassThroughOptions } from '../chip';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, DesignToken, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
@ -44,6 +45,20 @@ export interface ChipsPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface ChipsSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: ChipsProps;
/**
* Defines current inline state.
*/
state: ChipsState;
}
/**
* Custom add event.
* @see {@link ChipsEmits.add}
@ -84,9 +99,10 @@ export interface ChipsPassThroughOptions {
*/
token?: ChipsPassThroughOptionType;
/**
* Used to pass attributes to the label's DOM element.
* Used to pass attributes to the Chip component.
* @see {@link ChipPassThroughOptions}
*/
label?: ChipsPassThroughOptionType;
label?: ChipPassThroughOptions<ChipsSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the remove token icon's DOM element.
*/

15
components/lib/chips/Chips.vue
View File

@ -28,11 +28,12 @@
v-bind="ptm('token')"
:data-p-focused="focusedIndex === i"
>
<slot name="chip" :class="cx('label')" :value="val">
<span :class="cx('label')" v-bind="ptm('label')">{{ val }}</span>
</slot>
<slot name="removetokenicon" :class="cx('removeTokenIcon')" :index="i" :onClick="(event) => removeItem(event, i)" :removeCallback="(event) => removeItem(event, i)">
<component :is="removeTokenIcon ? 'span' : 'TimesCircleIcon'" :class="[cx('removeTokenIcon'), removeTokenIcon]" @click="removeItem($event, i)" aria-hidden="true" v-bind="ptm('removeTokenIcon')" />
<slot name="chip" :class="cx('label')" :index="i" :value="val" :removeCallback="(event) => removeOption(event, i)">
<Chip :class="cx('label')" :label="val" :removeIcon="removeTokenIcon" removable @remove="removeItem($event, i)" :pt="ptm('label')">
<template #removeicon>
<slot name="removetokenicon" :class="cx('removeTokenIcon')" :index="i" :removeCallback="(event) => removeItem(event, i)" />
</template>
</Chip>
</slot>
</li>
<li :class="cx('inputToken')" role="option" v-bind="ptm('inputToken')">
@ -58,7 +59,7 @@
</template>
<script>
import TimesCircleIcon from 'primevue/icons/timescircle';
import Chip from 'primevue/chip';
import { UniqueComponentId } from 'primevue/utils';
import BaseChips from './BaseChips.vue';
@ -262,7 +263,7 @@ export default {
}
},
components: {
TimesCircleIcon: TimesCircleIcon
Chip
}
};
</script>

6
components/lib/multiselect/MultiSelect.d.ts vendored
View File

@ -9,6 +9,7 @@
*/
import { TransitionProps, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ChipPassThroughOptions } from '../chip';
import { InputTextPassThroughOptions } from '../inputtext';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, DesignToken, GlobalComponentConstructor, HintedString, PassThrough } from '../ts-helpers';
@ -133,9 +134,10 @@ export interface MultiSelectPassThroughOptions {
*/
token?: MultiSelectPassThroughOptionType;
/**
* Used to pass attributes to the token label's DOM element.
* Used to pass attributes to the Chip.
* @see {@link ChipPassThroughOptions}
*/
tokenLabel?: MultiSelectPassThroughOptionType;
tokenLabel?: ChipPassThroughOptions<MultiSelectSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the remove token icon's DOM element.
*/

17
components/lib/multiselect/MultiSelect.vue
View File

@ -31,12 +31,12 @@
</template>
<template v-else-if="display === 'chip'">
<div v-for="item of chipSelectedItems" :key="getLabelByValue(item)" :class="cx('token')" v-bind="ptm('token')">
<slot name="chip" :value="item">
<span :class="cx('tokenLabel')" v-bind="ptm('tokenLabel')">{{ getLabelByValue(item) }}</span>
</slot>
<slot v-if="!disabled" name="removetokenicon" :class="cx('removeTokenIcon')" :item="item" :onClick="(event) => removeOption(event, item)" :removeCallback="(event) => removeOption(event, item)">
<span v-if="removeTokenIcon" :class="[cx('removeTokenIcon'), removeTokenIcon]" @click.stop="removeOption($event, item)" v-bind="ptm('removeTokenIcon')" />
<TimesCircleIcon v-else :class="cx('removeTokenIcon')" @click.stop="removeOption($event, item)" v-bind="ptm('removeTokenIcon')" />
<slot name="chip" :value="item" :removeCallback="(event) => removeOption(event, item)">
<Chip :class="cx('tokenLabel')" :label="getLabelByValue(item)" :removeIcon="removeTokenIcon" removable @remove="removeOption($event, item)" :pt="ptm('tokenLabel')">
<template #removeicon>
<slot name="removetokenicon" :class="cx('removeTokenIcon')" :item="item" :removeCallback="(event) => removeOption(event, item)" />
</template>
</Chip>
</slot>
</div>
<template v-if="!modelValue || modelValue.length === 0">{{ placeholder || 'empty' }}</template>
@ -197,12 +197,12 @@
<script>
import { FilterService } from 'primevue/api';
import Checkbox from 'primevue/checkbox';
import Chip from 'primevue/chip';
import CheckIcon from 'primevue/icons/check';
import ChevronDownIcon from 'primevue/icons/chevrondown';
import SearchIcon from 'primevue/icons/search';
import SpinnerIcon from 'primevue/icons/spinner';
import TimesIcon from 'primevue/icons/times';
import TimesCircleIcon from 'primevue/icons/timescircle';
import InputText from 'primevue/inputtext';
import OverlayEventBus from 'primevue/overlayeventbus';
import Portal from 'primevue/portal';
@ -802,6 +802,7 @@ export default {
}
},
removeOption(event, optionValue) {
event.stopPropagation();
let value = this.modelValue.filter((val) => !ObjectUtils.equals(val, optionValue, this.equalityKey));
this.updateModel(event, value);
@ -1095,9 +1096,9 @@ export default {
Checkbox,
VirtualScroller,
Portal,
Chip,
TimesIcon,
SearchIcon,
TimesCircleIcon,
ChevronDownIcon,
SpinnerIcon,
CheckIcon

6
components/lib/treeselect/TreeSelect.d.ts vendored
View File

@ -9,6 +9,7 @@
*/
import { InputHTMLAttributes, TransitionProps, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ChipPassThroughOptions } from '../chip';
import { PassThroughOptions } from '../passthrough';
import { TreeExpandedKeys, TreePassThroughOptions } from '../tree';
import { TreeNode } from '../treenode';
@ -84,9 +85,10 @@ export interface TreeSelectPassThroughOptions {
*/
token?: TreeSelectPassThroughOptionType;
/**
* Used to pass attributes to the token label's DOM element.
* Used to pass attributes to the Chip.
* @see {@link ChipPassThroughOptions}
*/
tokenLabel?: TreeSelectPassThroughOptionType;
tokenLabel?: ChipPassThroughOptions<TreeSelectSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the trigger's DOM element.
*/

4
components/lib/treeselect/TreeSelect.vue
View File

@ -30,7 +30,7 @@
</template>
<template v-else-if="display === 'chip'">
<div v-for="node of selectedNodes" :key="node.key" :class="cx('token')" v-bind="ptm('token')">
<span :class="cx('tokenLabel')" v-bind="ptm('tokenLabel')">{{ node.label }}</span>
<Chip :class="cx('tokenLabel')" :label="node.label" :pt="ptm('tokenLabel')" />
</div>
<template v-if="emptyValue">{{ placeholder || 'empty' }}</template>
</template>
@ -106,6 +106,7 @@
</template>
<script>
import Chip from 'primevue/chip';
import ChevronDownIcon from 'primevue/icons/chevrondown';
import OverlayEventBus from 'primevue/overlayeventbus';
import Portal from 'primevue/portal';
@ -500,6 +501,7 @@ export default {
},
components: {
TSTree: Tree,
Chip,
Portal: Portal,
ChevronDownIcon: ChevronDownIcon
},

55
doc/common/apidoc/index.json
View File

@ -3313,9 +3313,9 @@
"name": "tokenLabel",
"optional": true,
"readonly": false,
"type": "AutoCompletePassThroughOptionType",
"type": "ChipPassThroughOptions<AutoCompleteSharedPassThroughMethodOptions>",
"default": "",
"description": "Used to pass attributes to the token label's DOM element."
"description": "Used to pass attributes to the Chip."
},
{
"name": "removeTokenIcon",
@ -11969,7 +11969,7 @@
"name": "parent",
"optional": false,
"readonly": false,
"type": "any",
"type": "T",
"default": "",
"description": "Defines parent options."
},
@ -11992,7 +11992,7 @@
"name": "root",
"optional": true,
"readonly": false,
"type": "ChipPassThroughOptionType",
"type": "ChipPassThroughOptionType<T>",
"default": "",
"description": "Used to pass attributes to the root's DOM element."
},
@ -12000,7 +12000,7 @@
"name": "image",
"optional": true,
"readonly": false,
"type": "ChipPassThroughOptionType",
"type": "ChipPassThroughOptionType<T>",
"default": "",
"description": "Used to pass attributes to the image's DOM element."
},
@ -12008,7 +12008,7 @@
"name": "icon",
"optional": true,
"readonly": false,
"type": "ChipPassThroughOptionType",
"type": "ChipPassThroughOptionType<T>",
"default": "",
"description": "Used to pass attributes to the icon's DOM element."
},
@ -12016,7 +12016,7 @@
"name": "label",
"optional": true,
"readonly": false,
"type": "ChipPassThroughOptionType",
"type": "ChipPassThroughOptionType<T>",
"default": "",
"description": "Used to pass attributes to the label' DOM element."
},
@ -12024,7 +12024,7 @@
"name": "removeIcon",
"optional": true,
"readonly": false,
"type": "ChipPassThroughOptionType",
"type": "ChipPassThroughOptionType<T>",
"default": "",
"description": "Used to pass attributes to the removeIcon's DOM element."
},
@ -12125,7 +12125,7 @@
"name": "pt",
"optional": true,
"readonly": false,
"type": "PassThrough<ChipPassThroughOptions>",
"type": "PassThrough<ChipPassThroughOptions<any>>",
"default": "",
"description": "Used to pass attributes to DOM elements inside the component."
},
@ -12342,6 +12342,29 @@
],
"methods": []
},
"ChipsSharedPassThroughMethodOptions": {
"description": "Custom shared passthrough(pt) option method.",
"relatedProp": "",
"props": [
{
"name": "props",
"optional": false,
"readonly": false,
"type": "ChipsProps",
"default": "",
"description": "Defines valid properties."
},
{
"name": "state",
"optional": false,
"readonly": false,
"type": "ChipsState",
"default": "",
"description": "Defines current inline state."
}
],
"methods": []
},
"ChipsAddEvent": {
"description": "Custom add event.",
"relatedProp": "ChipsEmits.add",
@ -12422,9 +12445,9 @@
"name": "label",
"optional": true,
"readonly": false,
"type": "ChipsPassThroughOptionType",
"type": "ChipPassThroughOptions<ChipsSharedPassThroughMethodOptions>",
"default": "",
"description": "Used to pass attributes to the label's DOM element."
"description": "Used to pass attributes to the Chip component."
},
{
"name": "removeTokenIcon",
@ -15330,7 +15353,7 @@
"name": "chip",
"optional": true,
"readonly": false,
"type": "DefaultPassThrough<ChipPassThroughOptions>",
"type": "DefaultPassThrough<ChipPassThroughOptions<any>>",
"default": ""
},
{
@ -37960,9 +37983,9 @@
"name": "tokenLabel",
"optional": true,
"readonly": false,
"type": "MultiSelectPassThroughOptionType",
"type": "ChipPassThroughOptions<MultiSelectSharedPassThroughMethodOptions>",
"default": "",
"description": "Used to pass attributes to the token label's DOM element."
"description": "Used to pass attributes to the Chip."
},
{
"name": "removeTokenIcon",
@ -58228,9 +58251,9 @@
"name": "tokenLabel",
"optional": true,
"readonly": false,
"type": "TreeSelectPassThroughOptionType",
"type": "ChipPassThroughOptions<TreeSelectSharedPassThroughMethodOptions>",
"default": "",
"description": "Used to pass attributes to the token label's DOM element."
"description": "Used to pass attributes to the Chip."
},
{
"name": "trigger",

1
nuxt-vite.config.js
View File

@ -255,6 +255,7 @@ export default {
'primevue/badge': path.resolve(__dirname, './components/lib/badge/Badge.vue'),
'primevue/togglebutton': path.resolve(__dirname, './components/lib/togglebutton/ToggleButton.vue'),
'primevue/listbox': path.resolve(__dirname, './components/lib/listbox/Listbox.vue'),
'primevue/chip': path.resolve(__dirname, './components/lib/chip/Chip.vue'),
'primevue/confirmationeventbus': path.resolve(__dirname, './components/lib/confirmationeventbus/ConfirmationEventBus.js'),
'primevue/toasteventbus': path.resolve(__dirname, './components/lib/toasteventbus/ToastEventBus.js'),
'primevue/overlayeventbus': path.resolve(__dirname, './components/lib/overlayeventbus/OverlayEventBus.js'),

1
rollup.config.js
View File

@ -265,6 +265,7 @@ const CORE_DEPENDENCIES = {
'primevue/tieredmenu': 'primevue.tieredmenu',
'primevue/badge': 'primevue.badge',
'primevue/listbox': 'primevue.listbox',
'primevue/chip': 'primevue.chip',
'primevue/togglebutton': 'primevue.togglebutton',
...CORE_PASSTHROUGH_DEPENDENCIES,
...CORE_THEME_DEPENDENCIES