diff --git a/components/styleclass/StyleClass.d.ts b/components/styleclass/StyleClass.d.ts index e21fdfd5c..e668c25f0 100644 --- a/components/styleclass/StyleClass.d.ts +++ b/components/styleclass/StyleClass.d.ts @@ -1,5 +1,74 @@ -import { ObjectDirective } from 'vue'; +/** + * + * StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element. + * + * - [Live Demo](https://primevue.org/styleclass) + */ +import { DirectiveBinding, ObjectDirective } from 'vue'; +/** + * Defines options of StyleClass. + */ +export interface StyleClassOptions { + /** + * Selector to define the target element. + */ + selector?: '@next' | '@prev' | '@parent' | '@grandparent' | string | undefined; + /** + * Style class to add when item begins to get displayed. + */ + enterClassName?: string | undefined; + /** + * Style class to add during enter animation. + */ + enterActiveClassName?: string | undefined; + /** + * Style class to add when item begins to get displayed. + */ + enterToClassName?: string | undefined; + /** + * Style class to add when item begins to get hidden. + */ + leaveClassName?: string | undefined; + /** + * Style class to add during leave animation. + */ + leaveActiveClassName?: string | undefined; + /** + * Style class to add when leave animation is completed. + */ + leaveToClassName?: string | undefined; + /** + * Whether to trigger leave animation when outside of the element is clicked. + * @defaultValue false + */ + hideOnOutsideClick?: boolean | undefined; + /** + * Adds or removes a class when no enter-leave animation is required. + */ + toggleClass?: string | undefined; +} + +/** + * Binding of StyleClass directive. + */ +export interface StyleClassDirectiveBinding extends Omit { + /** + * Value of the StyleClass. + */ + value?: StyleClassOptions | undefined; +} + +/** + * **PrimeVue - StyleClass** + * + * _StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element._ + * + * [Live Demo](https://www.primevue.org/styleclass/) + * --- --- + * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg) + * + */ declare const StyleClass: ObjectDirective; export default StyleClass;