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

Update `CheckboxGroup` types

pull/6632/head
Mert Sincan 2024-10-21 00:25:56 +01:00
parent 2458008489
commit 59d01c2ade
3 changed files with 60 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/primevue/src/checkbox/Checkbox.vue
View File

@ -99,7 +99,7 @@ export default {
}, },
computed: { computed: {
groupName() { groupName() {
return this.$pcCheckboxGroup ? this.$pcCheckboxGroup.groupName : this.name; return this.$pcCheckboxGroup ? this.$pcCheckboxGroup.groupName : this.$formName;
}, },
checked() { checked() {
const value = this.$pcCheckboxGroup ? this.$pcCheckboxGroup.d_value : this.d_value; const value = this.$pcCheckboxGroup ? this.$pcCheckboxGroup.d_value : this.d_value;

89
packages/primevue/src/checkboxgroup/CheckboxGroup.d.ts vendored
View File

@ -1,25 +1,23 @@
/** /**
* *
* FloatLabel visually integrates a label with its form element. * CheckboxGroup is a component that groups multiple checkboxes, allowing users to select one or more options.
* *
* [Live Demo](https://www.primevue.org/floatlabel/) * [Live Demo](https://www.primevue.org/checkbox/)
* *
* @module floatlabel * @module checkboxgroup
* *
*/ */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core'; import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent'; import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough'; import type { PassThroughOptions } from 'primevue/passthrough';
import { TransitionProps, VNode } from 'vue'; import { VNode } from 'vue';
export declare type FloatLabelPassThroughOptionType = FloatLabelPassThroughAttributes | ((options: FloatLabelPassThroughMethodOptions) => FloatLabelPassThroughAttributes | string) | string | null | undefined; export declare type CheckboxGroupPassThroughOptionType = CheckboxGroupPassThroughAttributes | ((options: CheckboxGroupPassThroughMethodOptions) => CheckboxGroupPassThroughAttributes | string) | string | null | undefined;
export declare type FloatLabelPassThroughTransitionType = TransitionProps | ((options: FloatLabelPassThroughMethodOptions) => TransitionProps) | undefined;
/** /**
* Custom passthrough(pt) option method. * Custom passthrough(pt) option method.
*/ */
export interface FloatLabelPassThroughMethodOptions { export interface CheckboxGroupPassThroughMethodOptions {
/** /**
* Defines instance. * Defines instance.
*/ */
@ -27,7 +25,7 @@ export interface FloatLabelPassThroughMethodOptions {
/** /**
* Defines valid properties. * Defines valid properties.
*/ */
props: FloatLabelProps; props: CheckboxGroupProps;
/** /**
* Defines valid attributes. * Defines valid attributes.
*/ */
@ -46,11 +44,11 @@ export interface FloatLabelPassThroughMethodOptions {
* Custom passthrough(pt) options. * Custom passthrough(pt) options.
* @see {@link FloatLabelProps.pt} * @see {@link FloatLabelProps.pt}
*/ */
export interface FloatLabelPassThroughOptions { export interface CheckboxGroupPassThroughOptions {
/** /**
* Used to pass attributes to the root's DOM element. * Used to pass attributes to the root's DOM element.
*/ */
root?: FloatLabelPassThroughOptionType; root?: CheckboxGroupPassThroughOptionType;
/** /**
* Used to manage all lifecycle hooks. * Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks} * @see {@link BaseComponent.ComponentHooks}
@ -61,23 +59,44 @@ export interface FloatLabelPassThroughOptions {
/** /**
* Custom passthrough attributes for each DOM elements * Custom passthrough attributes for each DOM elements
*/ */
export interface FloatLabelPassThroughAttributes { export interface CheckboxGroupPassThroughAttributes {
[key: string]: any; [key: string]: any;
} }
/** /**
* Defines valid properties in FloatLabel component. * Defines valid properties in CheckboxGroup component.
*/ */
export interface FloatLabelProps { export interface CheckboxGroupProps {
/**
* Value binding of the checkboxes.
*/
modelValue?: any;
/**
* Default values of the checkboxes in uncontrolled mode.
*/
defaultValue?: any;
/**
* Name of the input elements.
*/
name?: string | undefined;
/**
* When present, it specifies that the component should have invalid state style.
* @defaultValue false
*/
invalid?: boolean | undefined;
/**
* Used to set form control options.
*/
formControl?: any;
/** /**
* It generates scoped CSS variables using design tokens for the component. * It generates scoped CSS variables using design tokens for the component.
*/ */
dt?: DesignToken<any>; dt?: DesignToken<any>;
/** /**
* Used to pass attributes to DOM elements inside the component. * Used to pass attributes to DOM elements inside the component.
* @type {FloatLabelPassThroughOptions} * @type {CheckboxGroupPassThroughOptions}
*/ */
pt?: PassThrough<FloatLabelPassThroughOptions>; pt?: PassThrough<CheckboxGroupPassThroughOptions>;
/** /**
* Used to configure passthrough(pt) options of the component. * Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions} * @type {PassThroughOptions}
@ -88,17 +107,12 @@ export interface FloatLabelProps {
* @defaultValue false * @defaultValue false
*/ */
unstyled?: boolean; unstyled?: boolean;
/**
* Defines the positioning of the label relative to the input.
* @defaultValue false
*/
variant?: 'over' | 'in' | 'on' | undefined;
} }
/** /**
* Defines valid slots in FloatLabel component. * Defines valid slots in CheckboxGroup component.
*/ */
export interface FloatLabelSlots { export interface CheckboxGroupSlots {
/** /**
* Default content slot. * Default content slot.
*/ */
@ -106,30 +120,41 @@ export interface FloatLabelSlots {
} }
/** /**
* Defines valid emits in FloatLabel component. * Defines valid emits in CheckboxGroup component.
*/ */
export interface FloatLabelEmitsOptions {} export interface CheckboxGroupEmitsOptions {
/**
* Emitted when the value changes.
* @param {*} value - New value.
*/
'update:modelValue'(value: any): void;
/**
* Emitted when the value changes in uncontrolled mode.
* @param {*} value - New value.
*/
'value-change'(value: any): void;
}
export declare type FloatLabelEmits = EmitFn<FloatLabelEmitsOptions>; export declare type CheckboxGroupEmits = EmitFn<CheckboxGroupEmitsOptions>;
/** /**
* **PrimeVue - FloatLabel** * **PrimeVue - CheckboxGroup**
* *
* _FloatLabel visually integrates a label with its form element._ * _CheckboxGroup is a component that groups multiple checkboxes, allowing users to select one or more options._
* *
* [Live Demo](https://www.primevue.org/inputtext/) * [Live Demo](https://www.primevue.org/checkbox/)
* --- --- * --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png) * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
* *
* @group Component * @group Component
* *
*/ */
declare const FloatLabel: DefineComponent<FloatLabelProps, FloatLabelSlots, FloatLabelEmits>; declare const CheckboxGroup: DefineComponent<CheckboxGroupProps, CheckboxGroupSlots, CheckboxGroupEmits>;
declare module 'vue' { declare module 'vue' {
export interface GlobalComponents { export interface GlobalComponents {
FloatLabel: DefineComponent<FloatLabelProps, FloatLabelSlots, FloatLabelEmits>; CheckboxGroup: DefineComponent<CheckboxGroupProps, CheckboxGroupSlots, CheckboxGroupEmits>;
} }
} }
export default FloatLabel; export default CheckboxGroup;

4
packages/primevue/src/checkboxgroup/style/CheckboxGroupStyle.d.ts vendored
View File

@ -1,8 +1,8 @@
/** /**
* *
* FloatLabel visually integrates a label with its form element. * CheckboxGroup is a component that groups multiple checkboxes, allowing users to select one or more options.
* *
* [Live Demo](https://www.primevue.org/floatlabel/) * [Live Demo](https://www.primevue.org/checkbox/)
* *
* @module checkboxgroupstyle * @module checkboxgroupstyle
* *