DataViewLayoutOptions .d.ts updated

pull/3699/head
Tuğçe Küçükoğlu 2023-03-03 16:17:50 +03:00
parent 407eb57ead
commit 9e93c3bbd0
2 changed files with 34 additions and 14 deletions

View File

@ -1,5 +1,17 @@
/**
*
* The helper DataViewLayoutOptions component can be used to switch between the modes however this component is optional and you may use your own UI to switch modes as well.
*
* [Live Demo](https://www.primevue.org/dataview/)
*
* @module dataviewlayoutoptions
*
*/
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Defines valid properties in DataViewLayoutOptions component.
*/
export interface DataViewLayoutOptionsProps {
/**
* Value of the component.
@ -7,16 +19,34 @@ export interface DataViewLayoutOptionsProps {
modelValue?: string | undefined;
}
/**
* Defines valid propslotserties in DataViewLayoutOptions component.
*/
export interface DataViewLayoutOptionsSlots {}
export declare type DataViewLayoutOptionsEmits = {
/**
* Defines valid emits in DataViewLayoutOptions component.
*/
export interface DataViewLayoutOptionsEmits {
/**
* Emitted when the value changes.
* @param {*} value - New value.
*/
'update:modelValue': (value: string) => void;
};
'update:modelValue'(value: string): void;
}
/**
* **PrimeVue - DataViewLayoutOptions**
*
* _The helper DataViewLayoutOptions component can be used to switch between the modes however this component is optional and you may use your own UI to switch modes as well._
*
* [Live Demo](https://www.primevue.org/dataview/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*
*/
declare class DataViewLayoutOptions extends ClassComponent<DataViewLayoutOptionsProps, DataViewLayoutOptionsSlots, DataViewLayoutOptionsEmits> {}
declare module '@vue/runtime-core' {
@ -25,14 +55,4 @@ declare module '@vue/runtime-core' {
}
}
/**
*
* When both layout modes are enabled in DataView, a UI element would be necessary to let the user toggle between the view.
* DataViewLayoutOptions is a helper component to display a buttonset to choose the layout mode in DataView.
*
* Demos:
*
* - [DataViewLayoutOptions](https://primevue.org/dataview)
*
*/
export default DataViewLayoutOptions;

View File

@ -1,5 +1,5 @@
<template>
<DocComponent title="Vue DataView Component" header="DataView" description="DataView displays data in grid or list layout with pagination and sorting features." :componentDocs="docs" :apiDocs="['DataView']" />
<DocComponent title="Vue DataView Component" header="DataView" description="DataView displays data in grid or list layout with pagination and sorting features." :componentDocs="docs" :apiDocs="['DataView', 'DataViewLayoutOptions']" />
</template>
<script>