primevue-mirror/packages/primevue/src/chips/Chips.d.ts

91 lines
2.3 KiB
TypeScript
Raw Normal View History

2023-03-01 12:15:52 +00:00
/**
*
* Chips groups a collection of contents in tabs.
*
2024-04-18 14:18:40 +00:00
* [Live Demo](https://www.primevue.org/inputchips/)
2023-03-01 12:15:52 +00:00
*
* @module chips
*
*/
2024-06-11 23:08:08 +00:00
import type { DefineComponent, EmitFn, GlobalComponentConstructor } from '@primevue/core';
import * as InputChips from 'primevue/inputchips';
2024-04-18 14:18:40 +00:00
import 'vue';
2023-05-05 09:36:30 +00:00
/**
* Custom passthrough(pt) option method.
*/
2024-04-18 14:18:40 +00:00
export interface ChipsPassThroughMethodOptions extends InputChips.InputChipsPassThroughMethodOptions {}
2023-05-05 09:36:30 +00:00
2024-04-08 12:20:51 +00:00
/**
* Custom shared passthrough(pt) option method.
*/
2024-04-18 14:18:40 +00:00
export interface ChipsSharedPassThroughMethodOptions extends InputChips.InputChipsSharedPassThroughMethodOptions {}
2024-04-08 12:20:51 +00:00
2023-03-01 12:15:52 +00:00
/**
2023-03-06 20:35:39 +00:00
* Custom add event.
2024-05-16 14:05:43 +00:00
* @see {@link ChipsEmitsOptions.add}
2023-03-01 12:15:52 +00:00
*/
2024-04-18 14:18:40 +00:00
export interface ChipsAddEvent extends InputChips.InputChipsAddEvent {}
2022-09-06 12:03:37 +00:00
/**
2023-03-01 12:15:52 +00:00
* Custom remove event.
2024-05-16 14:05:43 +00:00
* @see {@link ChipsEmitsOptions.remove}
2022-09-06 12:03:37 +00:00
* @extends ChipsAddEvent
*/
2022-09-14 11:26:01 +00:00
export interface ChipsRemoveEvent extends ChipsAddEvent {}
2022-09-06 12:03:37 +00:00
2023-05-05 09:36:30 +00:00
/**
* Custom passthrough(pt) options.
* @see {@link ChipsProps.pt}
*/
2024-04-18 14:18:40 +00:00
export interface ChipsPassThroughOptions extends InputChips.InputChipsPassThroughOptions {}
2023-05-05 09:36:30 +00:00
/**
* Custom passthrough attributes for each DOM elements
*/
2024-04-18 14:18:40 +00:00
export interface ChipsPassThroughAttributes extends InputChips.InputChipsPassThroughAttributes {}
2023-05-05 09:36:30 +00:00
/**
* Defines current inline state in Chips component.
*/
2024-04-18 14:18:40 +00:00
export interface ChipsState extends InputChips.InputChipsState {}
2023-05-05 09:36:30 +00:00
2023-03-01 12:15:52 +00:00
/**
* Defines valid properties in Chips component.
*/
2024-04-18 14:18:40 +00:00
export interface ChipsProps extends InputChips.InputChipsProps {}
2023-03-01 12:15:52 +00:00
/**
* Defines valid slots in Chips slots.
*/
2024-04-18 14:18:40 +00:00
export interface ChipsSlots extends InputChips.InputChipsSlots {}
2023-03-01 12:15:52 +00:00
/**
* Defines valid emits in Chips component.
*/
2024-05-16 14:05:43 +00:00
export interface ChipsEmitsOptions {}
export declare type ChipsEmits = EmitFn<ChipsEmitsOptions> & InputChips.InputChipsEmits;
2022-09-06 12:03:37 +00:00
2023-03-01 12:15:52 +00:00
/**
* @deprecated since v4. Use InputChips component instead.
2024-04-18 14:18:40 +00:00
*
2023-03-01 12:15:52 +00:00
* **PrimeVue - Chips**
*
* _Chips is used to enter multiple values on an input field._
*
2024-04-18 14:18:40 +00:00
* [Live Demo](https://www.primevue.org/inputchips/)
2023-03-01 12:15:52 +00:00
* --- ---
2023-03-03 10:55:20 +00:00
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
2023-03-01 12:15:52 +00:00
*
* @group Component
*
*/
declare const Chips: DefineComponent<ChipsProps, ChipsSlots, ChipsEmits>;
2022-09-06 12:03:37 +00:00
declare module 'vue' {
export interface GlobalComponents {
Chips: GlobalComponentConstructor<ChipsProps, ChipsSlots, ChipsEmits>;
2022-09-06 12:03:37 +00:00
}
}
export default Chips;