From 4f2041fac6228af84076b17efe342b9741a01838 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tu=C4=9F=C3=A7e=20K=C3=BC=C3=A7=C3=BCko=C4=9Flu?= Date: Mon, 8 Aug 2022 17:02:07 +0300 Subject: [PATCH] update docs --- api-generator/components/calendar.js | 24 ++++ api-generator/components/checkbox.js | 6 + api-generator/components/chips.js | 6 + api-generator/components/colorpicker.js | 2 +- api-generator/components/inputnumber.js | 24 +++- api-generator/components/inputswitch.js | 6 + api-generator/components/password.js | 12 ++ api-generator/components/radiobutton.js | 44 ++++++- api-generator/components/togglebutton.js | 6 + api-generator/components/tristatecheckbox.js | 26 ++-- src/components/calendar/Calendar.d.ts | 20 ++- src/components/checkbox/Checkbox.d.ts | 4 +- src/components/chips/Chips.d.ts | 20 +-- src/components/inputnumber/InputNumber.d.ts | 12 +- src/components/inputswitch/InputSwitch.d.ts | 4 +- src/components/password/Password.d.ts | 8 +- src/components/radiobutton/RadioButton.d.ts | 4 +- src/components/togglebutton/ToggleButton.d.ts | 4 +- src/components/togglebutton/ToggleButton.vue | 119 +----------------- .../tristatecheckbox/TriStateCheckbox.d.ts | 4 +- src/views/calendar/CalendarDoc.vue | 14 ++- src/views/checkbox/CheckboxDoc.vue | 2 +- src/views/chips/ChipsDoc.vue | 6 + src/views/inputnumber/InputNumberDoc.vue | 18 +++ src/views/inputswitch/InputSwitchDoc.vue | 8 +- src/views/password/PasswordDoc.vue | 12 ++ src/views/radiobutton/RadioButtonDoc.vue | 6 + src/views/togglebutton/ToggleButtonDoc.vue | 6 + .../tristatecheckbox/TriStateCheckboxDoc.vue | 24 +++- 29 files changed, 276 insertions(+), 175 deletions(-) diff --git a/api-generator/components/calendar.js b/api-generator/components/calendar.js index f53834be0..002269e4f 100644 --- a/api-generator/components/calendar.js +++ b/api-generator/components/calendar.js @@ -250,6 +250,30 @@ const CalendarProps = [ type: "any", default: "null", description: "Inline style of the input field." + }, + { + name: "inputProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + name: "panelClass", + type: "string", + default: "null", + description: "Style class of the overlay panel." + }, + { + name: "panelStyle", + type: "string", + default: "null", + description: "Inline style of the overlay panel." + }, + { + name: "panelProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." } ]; diff --git a/api-generator/components/checkbox.js b/api-generator/components/checkbox.js index 74cbb1deb..97cfa845b 100644 --- a/api-generator/components/checkbox.js +++ b/api-generator/components/checkbox.js @@ -71,6 +71,12 @@ const CheckboxProps = [ default: "null", description: "Inline style of the input field." }, + { + name: "inputProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, { name: "aria-labelledby", type: "string", diff --git a/api-generator/components/chips.js b/api-generator/components/chips.js index 1356ae366..1dc3ff05c 100644 --- a/api-generator/components/chips.js +++ b/api-generator/components/chips.js @@ -52,6 +52,12 @@ const ChipsProps = [ type: "any", default: "null", description: "Inline style of the input field." + }, + { + name: "inputProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." } ]; diff --git a/api-generator/components/colorpicker.js b/api-generator/components/colorpicker.js index 8c561d329..c5826a7eb 100644 --- a/api-generator/components/colorpicker.js +++ b/api-generator/components/colorpicker.js @@ -30,7 +30,7 @@ const ColorPickerProps = [ description: "When present, it specifies that the component should be disabled." }, { - name: "tabIndex", + name: "tabindex", type: "string", default: "null", description: "Index of the element in tabbing order." diff --git a/api-generator/components/inputnumber.js b/api-generator/components/inputnumber.js index 6cfaf9a73..506cabd09 100644 --- a/api-generator/components/inputnumber.js +++ b/api-generator/components/inputnumber.js @@ -137,6 +137,12 @@ const InputNumberProps = [ default: "false", description: "When present, it specifies that an input field is read-only." }, + { + name: "inputId", + type: "string", + default: "null", + description: "Identifier of the underlying input element." + }, { name: "inputStyle", type: "any", @@ -150,16 +156,22 @@ const InputNumberProps = [ description: "Style class of the input field." }, { - name: "class", - type: "string", + name: "inputProps", + type: "object", default: "null", - description: "Style class of the component." + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." }, { - name: "style", - type: "any", + name: "incrementButtonProps", + type: "object", default: "null", - description: "Inline of the component." + description: "Uses to pass all properties of the HTMLButtonElement to increment button inside the component." + }, + { + name: "decrementButtonProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLButtonElement to decrement button inside the component." } ]; diff --git a/api-generator/components/inputswitch.js b/api-generator/components/inputswitch.js index d0794da2e..262ad3ed2 100644 --- a/api-generator/components/inputswitch.js +++ b/api-generator/components/inputswitch.js @@ -34,6 +34,12 @@ const InputSwitchProps = [ type: "string", default: "null", description: "Style class of the input field." + }, + { + name: "inputProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." } ]; diff --git a/api-generator/components/password.js b/api-generator/components/password.js index 335df8a4e..f293a7005 100644 --- a/api-generator/components/password.js +++ b/api-generator/components/password.js @@ -95,6 +95,12 @@ const PasswordProps = [ default: "null", description: "Style class of the input field." }, + { + name: "inputProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, { name: "panelId", type: "string", @@ -112,6 +118,12 @@ const PasswordProps = [ type: "string", default: "null", description: "Inline style of the overlay panel." + }, + { + name: "panelProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component." } ]; diff --git a/api-generator/components/radiobutton.js b/api-generator/components/radiobutton.js index 9a4f2aa7c..86e87b9b0 100644 --- a/api-generator/components/radiobutton.js +++ b/api-generator/components/radiobutton.js @@ -12,16 +12,52 @@ const RadioButtonProps = [ description: "Value binding of the checkbox." }, { - name: "class", + name: "name", type: "string", default: "null", - description: "Style class of the component." + description: "Name of the input element." }, { - name: "style", + name: "disabled", + type: "boolean", + default: "false", + description: "When present, it specifies that the element should be disabled." + }, + { + name: "inputId", + type: "string", + default: "null", + description: "Identifier of the underlying input element." + }, + { + name: "inputClass", + type: "string", + default: "null", + description: "Style class of the input field." + }, + { + name: "inputStyle", type: "any", default: "null", - description: "Inline of the component." + description: "Inline style of the input field." + }, + { + name: "inputProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." + }, + { + name: "aria-labelledby", + type: "string", + default: "null", + description: "Establishes relationships between the component and label(s) where its value should be one or more element IDs." + }, + { + name: "aria-label", + type: "string", + default: "null", + description: "Used to define a string that labels the element." } ]; diff --git a/api-generator/components/togglebutton.js b/api-generator/components/togglebutton.js index a4e4c44e3..0f1bfaf90 100644 --- a/api-generator/components/togglebutton.js +++ b/api-generator/components/togglebutton.js @@ -64,6 +64,12 @@ const ToggleButtonProps = [ type: "any", default: "null", description: "Inline style of the input field." + }, + { + name: "inputProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." } ]; diff --git a/api-generator/components/tristatecheckbox.js b/api-generator/components/tristatecheckbox.js index f23f084bb..646725d49 100644 --- a/api-generator/components/tristatecheckbox.js +++ b/api-generator/components/tristatecheckbox.js @@ -6,16 +6,28 @@ const TriStateCheckboxProps = [ description: "Value of the component." }, { - name: "class", - type: "string", - default: "null", - description: "Style class of the component." + name: "disabled", + type: "boolean", + default: "false", + description: "When present, it specifies that the component should be disabled." }, { - name: "style", - type: "any", + name: "tabindex", + type: "string", default: "null", - description: "Inline of the component." + description: "Index of the element in tabbing order." + }, + { + name: "inputId", + type: "string", + default: "null", + description: "Identifier of the underlying input element." + }, + { + name: "inputProps", + type: "object", + default: "null", + description: "Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component." }, { name: "aria-labelledby", diff --git a/src/components/calendar/Calendar.d.ts b/src/components/calendar/Calendar.d.ts index 627f3324e..c6e97b6ea 100755 --- a/src/components/calendar/Calendar.d.ts +++ b/src/components/calendar/Calendar.d.ts @@ -254,19 +254,27 @@ export interface CalendarProps { /** * Inline style of the input field. */ - inputStyle?: any; + inputStyle?: any | undefined; /** * Style class of the input field. */ - inputClass?: any; + inputClass?: any | undefined; /** - * + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. */ - inputProps?: object | undefined; + inputProps?: HTMLInputElement | undefined; /** - * + * Inline style of the overlay panel. */ - panelProps?: object | undefined; + panelStyle?: any | undefined; + /** + * Style class of the overlay panel. + */ + panelClass?: any | undefined; + /** + * Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component. + */ + panelProps?: HTMLDivElement | undefined; /** * Establishes relationships between the component and label(s) where its value should be one or more element IDs. */ diff --git a/src/components/checkbox/Checkbox.d.ts b/src/components/checkbox/Checkbox.d.ts index 09e32f63d..5f3fb3cc1 100755 --- a/src/components/checkbox/Checkbox.d.ts +++ b/src/components/checkbox/Checkbox.d.ts @@ -54,9 +54,9 @@ export interface CheckboxProps { */ inputStyle?: any | undefined; /** - * + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. */ - inputProps?: object | undefined; + inputProps?: HTMLInputElement | undefined; /** * Establishes relationships between the component and label(s) where its value should be one or more element IDs. */ diff --git a/src/components/chips/Chips.d.ts b/src/components/chips/Chips.d.ts index be4223628..c2f33e96f 100755 --- a/src/components/chips/Chips.d.ts +++ b/src/components/chips/Chips.d.ts @@ -52,9 +52,9 @@ export interface ChipsProps { */ inputStyle?: any | undefined; /** - * + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. */ - inputProps?: object | undefined; + inputProps?: HTMLInputElement | undefined; /** * When present, it specifies that the element should be disabled. */ @@ -88,15 +88,15 @@ export declare type ChipsEmits = { * @param {*} value - New value. */ 'update:modelValue': (value: any[]) => void; - /** - * Callback to invoke when a chip is added. - * @param {ChipsAddEvent} event - Custom add event. - */ + /** + * Callback to invoke when a chip is added. + * @param {ChipsAddEvent} event - Custom add event. + */ 'add': (event: ChipsAddEvent) => void; - /** - * Callback to invoke when a chip is removed. - * @param {ChipsRemoveEvent} event - Custom remove event. - */ + /** + * Callback to invoke when a chip is removed. + * @param {ChipsRemoveEvent} event - Custom remove event. + */ 'remove': (event: ChipsRemoveEvent) => void; } diff --git a/src/components/inputnumber/InputNumber.d.ts b/src/components/inputnumber/InputNumber.d.ts index b2f250d4b..7acc5d005 100755 --- a/src/components/inputnumber/InputNumber.d.ts +++ b/src/components/inputnumber/InputNumber.d.ts @@ -150,9 +150,17 @@ export interface InputNumberProps { */ inputStyle?: any | undefined; /** - * + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. */ - inputProps?: object | undefined; + inputProps?: HTMLInputElement | undefined; + /** + * Uses to pass all properties of the HTMLButtonElement to increment button inside the component. + */ + incrementButtonProps?: HTMLButtonElement | undefined; + /** + * Uses to pass all properties of the HTMLButtonElement to decrement button inside the component. + */ + decrementButtonProps?: HTMLButtonElement | undefined; /** * Establishes relationships between the component and label(s) where its value should be one or more element IDs. */ diff --git a/src/components/inputswitch/InputSwitch.d.ts b/src/components/inputswitch/InputSwitch.d.ts index 6ed6cf456..05cd3f355 100755 --- a/src/components/inputswitch/InputSwitch.d.ts +++ b/src/components/inputswitch/InputSwitch.d.ts @@ -26,9 +26,9 @@ export interface InputSwitchProps { */ inputStyle?: any | undefined; /** - * + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. */ - inputProps?: object | undefined; + inputProps?: HTMLInputElement | undefined; /** * Establishes relationships between the component and label(s) where its value should be one or more element IDs. */ diff --git a/src/components/password/Password.d.ts b/src/components/password/Password.d.ts index c386a9ce6..ed1eaabb9 100755 --- a/src/components/password/Password.d.ts +++ b/src/components/password/Password.d.ts @@ -71,6 +71,10 @@ export interface PasswordProps extends InputHTMLAttributes { * Style class of the input field. */ inputClass?: any | undefined; + /** + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. + */ + inputProps?: HTMLInputElement | undefined; /** * Identifier of the underlying overlay panel element. */ @@ -84,9 +88,9 @@ export interface PasswordProps extends InputHTMLAttributes { */ panelStyle?: any | undefined; /** - * + * Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component. */ - panelProps?: object | undefined; + panelProps?: HTMLDivElement | undefined; /** * Establishes relationships between the component and label(s) where its value should be one or more element IDs. */ diff --git a/src/components/radiobutton/RadioButton.d.ts b/src/components/radiobutton/RadioButton.d.ts index 51f867ada..24314859d 100755 --- a/src/components/radiobutton/RadioButton.d.ts +++ b/src/components/radiobutton/RadioButton.d.ts @@ -30,9 +30,9 @@ export interface RadioButtonProps { */ inputClass?: any; /** - * + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. */ - inputProps?: object | undefined; + inputProps?: HTMLInputElement | undefined; /** * Establishes relationships between the component and label(s) where its value should be one or more element IDs. */ diff --git a/src/components/togglebutton/ToggleButton.d.ts b/src/components/togglebutton/ToggleButton.d.ts index 4f58aa371..b7381467e 100755 --- a/src/components/togglebutton/ToggleButton.d.ts +++ b/src/components/togglebutton/ToggleButton.d.ts @@ -52,9 +52,9 @@ export interface ToggleButtonProps { */ inputStyle?: any | undefined; /** - * + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. */ - inputProps?: object | undefined; + inputProps?: HTMLInputElement | undefined; /** * Establishes relationships between the component and label(s) where its value should be one or more element IDs. */ diff --git a/src/components/togglebutton/ToggleButton.vue b/src/components/togglebutton/ToggleButton.vue index 51c2c1dc8..07dc0be48 100755 --- a/src/components/togglebutton/ToggleButton.vue +++ b/src/components/togglebutton/ToggleButton.vue @@ -100,121 +100,4 @@ export default { 'ripple': Ripple } } - - - - \ No newline at end of file + \ No newline at end of file diff --git a/src/components/tristatecheckbox/TriStateCheckbox.d.ts b/src/components/tristatecheckbox/TriStateCheckbox.d.ts index 600493285..401de9cad 100755 --- a/src/components/tristatecheckbox/TriStateCheckbox.d.ts +++ b/src/components/tristatecheckbox/TriStateCheckbox.d.ts @@ -18,9 +18,9 @@ export interface TriStateCheckboxProps { */ inputId?: string | undefined; /** - * + * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. */ - inputProps?: object | undefined; + inputProps?: HTMLInputElement | undefined; /** * Establishes relationships between the component and label(s) where its value should be one or more element IDs. */ diff --git a/src/views/calendar/CalendarDoc.vue b/src/views/calendar/CalendarDoc.vue index 6187d4ff6..aad7ca250 100755 --- a/src/views/calendar/CalendarDoc.vue +++ b/src/views/calendar/CalendarDoc.vue @@ -453,11 +453,17 @@ export default { null Style class of the input field. + + inputProps + object + null + Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. + panelClass string null - Style class of the datetimepicker panel. + Style class of the overlay panel. panelStyle @@ -465,6 +471,12 @@ export default { null Inline style of the overlay panel. + + panelProps + object + null + Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component. + diff --git a/src/views/checkbox/CheckboxDoc.vue b/src/views/checkbox/CheckboxDoc.vue index dcaf294d3..6f52e12c4 100755 --- a/src/views/checkbox/CheckboxDoc.vue +++ b/src/views/checkbox/CheckboxDoc.vue @@ -139,7 +139,7 @@ export default { inputProps object null - + Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. diff --git a/src/views/chips/ChipsDoc.vue b/src/views/chips/ChipsDoc.vue index 57383fe8c..2f51374fb 100755 --- a/src/views/chips/ChipsDoc.vue +++ b/src/views/chips/ChipsDoc.vue @@ -100,6 +100,12 @@ import Chips from 'primevue/chips'; any null Inline style of the input field. + + + inputProps + object + null + Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. diff --git a/src/views/inputnumber/InputNumberDoc.vue b/src/views/inputnumber/InputNumberDoc.vue index a3b8307fb..b9eae7df5 100755 --- a/src/views/inputnumber/InputNumberDoc.vue +++ b/src/views/inputnumber/InputNumberDoc.vue @@ -296,6 +296,24 @@ Vertical null Style class of the input field. + + inputProps + object + null + Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. + + + incrementButtonProps + object + null + Uses to pass all properties of the HTMLButtonElement to increment button inside the component. + + + decrementButtonProps + object + null + Uses to pass all properties of the HTMLButtonElement to decrement button inside the component. + diff --git a/src/views/inputswitch/InputSwitchDoc.vue b/src/views/inputswitch/InputSwitchDoc.vue index 5484d0b5a..111c00552 100755 --- a/src/views/inputswitch/InputSwitchDoc.vue +++ b/src/views/inputswitch/InputSwitchDoc.vue @@ -92,6 +92,12 @@ export default { any null Inline style of the input field. + + + inputProps + object + null + Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component. @@ -161,7 +167,7 @@ export default { 

 <label for="switch1">Remember Me</label>
-<InputSwitch id="switch1" />
+<InputSwitch inputId="switch1" />
 
 <span id="switch2">Remember Me</span>
 <InputSwitch aria-labelledby="switch2" />
diff --git a/src/views/password/PasswordDoc.vue b/src/views/password/PasswordDoc.vue
index d196f9f78..e7eadec70 100755
--- a/src/views/password/PasswordDoc.vue
+++ b/src/views/password/PasswordDoc.vue
@@ -173,6 +173,12 @@ import Password from 'primevue/password';
                         null
                         Inline style of the input field.
                     
+                    
+                        inputProps
+                        object
+                        null
+                        Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.
+                    
                     
                         panelId
                         string
@@ -190,6 +196,12 @@ import Password from 'primevue/password';
                         string
                         null
                         Inline style of the overlay panel.
+                    
+                    
+                        panelProps
+                        object
+                        null
+                        Uses to pass all properties of the HTMLDivElement to the overlay panel inside the component.
                     
 				
 			
diff --git a/src/views/radiobutton/RadioButtonDoc.vue b/src/views/radiobutton/RadioButtonDoc.vue
index e1e65bfcc..fbb99839c 100755
--- a/src/views/radiobutton/RadioButtonDoc.vue
+++ b/src/views/radiobutton/RadioButtonDoc.vue
@@ -96,6 +96,12 @@ export default {
                         any
                         null
                         Inline style of the input field.
+                    
+                    
+                        inputProps
+                        object
+                        null
+                        Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.
                     
 				
 			
diff --git a/src/views/togglebutton/ToggleButtonDoc.vue b/src/views/togglebutton/ToggleButtonDoc.vue
index dcd7b3570..82c3826f7 100755
--- a/src/views/togglebutton/ToggleButtonDoc.vue
+++ b/src/views/togglebutton/ToggleButtonDoc.vue
@@ -117,6 +117,12 @@ export default {
                         any
                         null
                         Inline style of the input field.
+                    
+                    
+                        inputProps
+                        object
+                        null
+                        Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.
                     
 				
 			
diff --git a/src/views/tristatecheckbox/TriStateCheckboxDoc.vue b/src/views/tristatecheckbox/TriStateCheckboxDoc.vue
index d3e80ad9d..1d5581c3d 100755
--- a/src/views/tristatecheckbox/TriStateCheckboxDoc.vue
+++ b/src/views/tristatecheckbox/TriStateCheckboxDoc.vue
@@ -40,16 +40,28 @@ import TriStateCheckbox from 'primevue/tristatecheckbox';
                         Value of the component.
                     
                     
-                        style
-                        any
-                        null
-                        Style class of the component.
+                        disabled
+                        boolean
+                        false
+                        When specified, disables the component.
                     
                     
-                        class
+                        tabindex
+                        number
+                        0
+                        Index of the element in tabbing order.
+                    
+                    
+                        inputId
                         string
                         null
-                        Inline style of the component.
+                        Style class of the component input field.
+                    
+                    
+                        inputProps
+                        object
+                        null
+                        Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.