@porsche-design-system/components-angular 4.2.0-rc.5 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/fesm2022/porsche-design-system-components-angular.mjs +233 -233
- package/fesm2022/porsche-design-system-components-angular.mjs.map +1 -1
- package/package.json +4 -4
- package/tailwindcss/index.css +57 -75
- package/types/porsche-design-system-components-angular.d.ts +555 -555
- package/vanilla-extract/cjs/font/fontHyphenationStyle.cjs +1 -1
- package/vanilla-extract/cjs/tokens/dist/esm/color/palette.cjs +10 -196
- package/vanilla-extract/esm/font/fontHyphenationStyle.mjs +1 -1
- package/vanilla-extract/esm/grid/gridSharedOffset.mjs +1 -1
- package/vanilla-extract/esm/grid/gridStyle.mjs +1 -1
- package/vanilla-extract/esm/tokens/dist/esm/color/palette.mjs +10 -196
|
@@ -1860,66 +1860,66 @@ type WordmarkAriaAttribute = LinkAriaAttribute;
|
|
|
1860
1860
|
|
|
1861
1861
|
type PCheckboxProps = {
|
|
1862
1862
|
/**
|
|
1863
|
-
* Reflects the checkbox current checked state and allows setting the initial checked
|
|
1863
|
+
* Reflects the checkbox's current checked state and allows setting the initial checked value on load.
|
|
1864
1864
|
* @default false
|
|
1865
1865
|
*/
|
|
1866
1866
|
checked?: boolean;
|
|
1867
1867
|
/**
|
|
1868
|
-
*
|
|
1868
|
+
* Reduces the checkbox size and spacing for a more compact layout.
|
|
1869
1869
|
* @default false
|
|
1870
1870
|
*/
|
|
1871
1871
|
compact?: boolean;
|
|
1872
1872
|
/**
|
|
1873
|
-
*
|
|
1873
|
+
* Disables the checkbox, preventing all interaction. The value is not submitted with the form.
|
|
1874
1874
|
* @default false
|
|
1875
1875
|
*/
|
|
1876
1876
|
disabled?: boolean;
|
|
1877
1877
|
/**
|
|
1878
|
-
*
|
|
1878
|
+
* Associates the checkbox with a form element by its ID when not directly nested inside it.
|
|
1879
1879
|
*/
|
|
1880
1880
|
form?: string;
|
|
1881
1881
|
/**
|
|
1882
|
-
*
|
|
1882
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
1883
1883
|
* @default false
|
|
1884
1884
|
*/
|
|
1885
1885
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
1886
1886
|
/**
|
|
1887
|
-
*
|
|
1887
|
+
* Puts the checkbox into an indeterminate state, indicating that a group of child items is only partially selected.
|
|
1888
1888
|
* @default false
|
|
1889
1889
|
*/
|
|
1890
1890
|
indeterminate?: boolean;
|
|
1891
1891
|
/**
|
|
1892
|
-
*
|
|
1892
|
+
* Sets the visible label text displayed next to the checkbox.
|
|
1893
1893
|
* @default ''
|
|
1894
1894
|
*/
|
|
1895
1895
|
label?: string;
|
|
1896
1896
|
/**
|
|
1897
|
-
* @experimental Disables the checkbox and
|
|
1897
|
+
* @experimental Disables the checkbox and displays a loading spinner to indicate an ongoing operation.
|
|
1898
1898
|
* @default false
|
|
1899
1899
|
*/
|
|
1900
1900
|
loading?: boolean;
|
|
1901
1901
|
/**
|
|
1902
|
-
*
|
|
1902
|
+
* Sets the validation feedback message displayed below the checkbox when `state` is `success` or `error`.
|
|
1903
1903
|
* @default ''
|
|
1904
1904
|
*/
|
|
1905
1905
|
message?: string;
|
|
1906
1906
|
/**
|
|
1907
|
-
*
|
|
1907
|
+
* Sets the name submitted with the form data to identify this checkbox's value on the server.
|
|
1908
1908
|
* @default ''
|
|
1909
1909
|
*/
|
|
1910
1910
|
name?: string;
|
|
1911
1911
|
/**
|
|
1912
|
-
* Marks the checkbox as required.
|
|
1912
|
+
* Marks the checkbox as required — form submission is blocked unless the checkbox is checked.
|
|
1913
1913
|
* @default false
|
|
1914
1914
|
*/
|
|
1915
1915
|
required?: boolean;
|
|
1916
1916
|
/**
|
|
1917
|
-
*
|
|
1917
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
1918
1918
|
* @default 'none'
|
|
1919
1919
|
*/
|
|
1920
1920
|
state?: CheckboxState;
|
|
1921
1921
|
/**
|
|
1922
|
-
*
|
|
1922
|
+
* Sets the value submitted with the form data when the checkbox is checked. Unchecked checkboxes are excluded from form submissions.
|
|
1923
1923
|
* @default 'on'
|
|
1924
1924
|
*/
|
|
1925
1925
|
value?: string;
|
|
@@ -1956,82 +1956,82 @@ declare class PCheckbox extends BaseComponent implements ControlValueAccessor {
|
|
|
1956
1956
|
|
|
1957
1957
|
type PInputDateProps = {
|
|
1958
1958
|
/**
|
|
1959
|
-
* Provides
|
|
1959
|
+
* Provides the browser with a date autofill hint (e.g. `autocomplete='bday'` for a birthday field).
|
|
1960
1960
|
*/
|
|
1961
1961
|
autoComplete?: string;
|
|
1962
1962
|
/**
|
|
1963
|
-
*
|
|
1963
|
+
* Reduces the input height and padding for a more compact layout.
|
|
1964
1964
|
* @default false
|
|
1965
1965
|
*/
|
|
1966
1966
|
compact?: boolean;
|
|
1967
1967
|
/**
|
|
1968
|
-
*
|
|
1968
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
1969
1969
|
* @default ''
|
|
1970
1970
|
*/
|
|
1971
1971
|
description?: string;
|
|
1972
1972
|
/**
|
|
1973
|
-
* Disables the
|
|
1973
|
+
* Disables the field, preventing date selection. The value is not submitted with the form.
|
|
1974
1974
|
* @default false
|
|
1975
1975
|
*/
|
|
1976
1976
|
disabled?: boolean;
|
|
1977
1977
|
/**
|
|
1978
|
-
*
|
|
1978
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
1979
1979
|
*/
|
|
1980
1980
|
form?: string;
|
|
1981
1981
|
/**
|
|
1982
|
-
*
|
|
1982
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
1983
1983
|
* @default false
|
|
1984
1984
|
*/
|
|
1985
1985
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
1986
1986
|
/**
|
|
1987
|
-
*
|
|
1987
|
+
* Sets the visible label text displayed above the input field.
|
|
1988
1988
|
* @default ''
|
|
1989
1989
|
*/
|
|
1990
1990
|
label?: string;
|
|
1991
1991
|
/**
|
|
1992
|
-
* @experimental
|
|
1992
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
1993
1993
|
* @default false
|
|
1994
1994
|
*/
|
|
1995
1995
|
loading?: boolean;
|
|
1996
1996
|
/**
|
|
1997
|
-
*
|
|
1997
|
+
* Sets the latest selectable date in YYYY-MM-DD format. Dates after this are disabled in the picker.
|
|
1998
1998
|
*/
|
|
1999
1999
|
max?: string;
|
|
2000
2000
|
/**
|
|
2001
|
-
*
|
|
2001
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
2002
2002
|
* @default ''
|
|
2003
2003
|
*/
|
|
2004
2004
|
message?: string;
|
|
2005
2005
|
/**
|
|
2006
|
-
*
|
|
2006
|
+
* Sets the earliest selectable date in YYYY-MM-DD format. Dates before this are disabled in the picker.
|
|
2007
2007
|
*/
|
|
2008
2008
|
min?: string;
|
|
2009
2009
|
/**
|
|
2010
|
-
*
|
|
2010
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
2011
2011
|
*/
|
|
2012
2012
|
name: string;
|
|
2013
2013
|
/**
|
|
2014
|
-
*
|
|
2014
|
+
* Makes the field read-only — the date is displayed but cannot be changed. The value is still submitted with the form.
|
|
2015
2015
|
* @default false
|
|
2016
2016
|
*/
|
|
2017
2017
|
readOnly?: boolean;
|
|
2018
2018
|
/**
|
|
2019
|
-
*
|
|
2019
|
+
* Marks the field as required — form submission is blocked while no date is selected.
|
|
2020
2020
|
* @default false
|
|
2021
2021
|
*/
|
|
2022
2022
|
required?: boolean;
|
|
2023
2023
|
/**
|
|
2024
|
-
*
|
|
2024
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
2025
2025
|
* @default 'none'
|
|
2026
2026
|
*/
|
|
2027
2027
|
state?: InputDateState;
|
|
2028
2028
|
/**
|
|
2029
|
-
*
|
|
2029
|
+
* Sets the stepping interval in days. The selected date must align with the `min` date by a multiple of this value.
|
|
2030
2030
|
* @default 1
|
|
2031
2031
|
*/
|
|
2032
2032
|
step?: number;
|
|
2033
2033
|
/**
|
|
2034
|
-
*
|
|
2034
|
+
* Sets the current date value in YYYY-MM-DD format (e.g. `2025-07-02`).
|
|
2035
2035
|
* @default ''
|
|
2036
2036
|
*/
|
|
2037
2037
|
value?: string | null;
|
|
@@ -2073,96 +2073,96 @@ declare class PInputDate extends BaseComponent implements ControlValueAccessor {
|
|
|
2073
2073
|
|
|
2074
2074
|
type PInputEmailProps = {
|
|
2075
2075
|
/**
|
|
2076
|
-
* Provides
|
|
2076
|
+
* Provides the browser with a data type hint to enable relevant autofill suggestions (e.g. `autocomplete='email'`).
|
|
2077
2077
|
*/
|
|
2078
2078
|
autoComplete?: string;
|
|
2079
2079
|
/**
|
|
2080
|
-
*
|
|
2080
|
+
* Reduces the input height and padding for a more compact layout.
|
|
2081
2081
|
* @default false
|
|
2082
2082
|
*/
|
|
2083
2083
|
compact?: boolean;
|
|
2084
2084
|
/**
|
|
2085
|
-
*
|
|
2085
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
2086
2086
|
* @default ''
|
|
2087
2087
|
*/
|
|
2088
2088
|
description?: string;
|
|
2089
2089
|
/**
|
|
2090
|
-
* Disables the input
|
|
2090
|
+
* Disables the field, preventing all input. The value is not submitted with the form.
|
|
2091
2091
|
* @default false
|
|
2092
2092
|
*/
|
|
2093
2093
|
disabled?: boolean;
|
|
2094
2094
|
/**
|
|
2095
|
-
*
|
|
2095
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
2096
2096
|
*/
|
|
2097
2097
|
form?: string;
|
|
2098
2098
|
/**
|
|
2099
|
-
*
|
|
2099
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
2100
2100
|
* @default false
|
|
2101
2101
|
*/
|
|
2102
2102
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
2103
2103
|
/**
|
|
2104
|
-
*
|
|
2104
|
+
* Shows an email icon at the start of the field as a visual indicator.
|
|
2105
2105
|
* @default false
|
|
2106
2106
|
*/
|
|
2107
2107
|
indicator?: boolean;
|
|
2108
2108
|
/**
|
|
2109
|
-
*
|
|
2109
|
+
* Sets the visible label text displayed above the input field.
|
|
2110
2110
|
* @default ''
|
|
2111
2111
|
*/
|
|
2112
2112
|
label?: string;
|
|
2113
2113
|
/**
|
|
2114
|
-
* @experimental
|
|
2114
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
2115
2115
|
* @default false
|
|
2116
2116
|
*/
|
|
2117
2117
|
loading?: boolean;
|
|
2118
2118
|
/**
|
|
2119
|
-
*
|
|
2119
|
+
* Sets the maximum number of characters the user can enter.
|
|
2120
2120
|
*/
|
|
2121
2121
|
maxLength?: number;
|
|
2122
2122
|
/**
|
|
2123
|
-
*
|
|
2123
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
2124
2124
|
* @default ''
|
|
2125
2125
|
*/
|
|
2126
2126
|
message?: string;
|
|
2127
2127
|
/**
|
|
2128
|
-
*
|
|
2128
|
+
* Sets the minimum number of characters required for the field to be considered valid.
|
|
2129
2129
|
*/
|
|
2130
2130
|
minLength?: number;
|
|
2131
2131
|
/**
|
|
2132
|
-
* Allows
|
|
2132
|
+
* Allows entry of multiple email addresses separated by commas. The browser validates each address individually.
|
|
2133
2133
|
* @default false
|
|
2134
2134
|
*/
|
|
2135
2135
|
multiple?: boolean;
|
|
2136
2136
|
/**
|
|
2137
|
-
*
|
|
2137
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
2138
2138
|
*/
|
|
2139
2139
|
name: string;
|
|
2140
2140
|
/**
|
|
2141
|
-
*
|
|
2141
|
+
* Sets a regular expression the entered value must match to be valid. Overrides the browser's default email validation.
|
|
2142
2142
|
*/
|
|
2143
2143
|
pattern?: string;
|
|
2144
2144
|
/**
|
|
2145
|
-
*
|
|
2145
|
+
* Sets placeholder text shown inside the field when it is empty, to hint at the expected format.
|
|
2146
2146
|
* @default ''
|
|
2147
2147
|
*/
|
|
2148
2148
|
placeholder?: string;
|
|
2149
2149
|
/**
|
|
2150
|
-
*
|
|
2150
|
+
* Makes the field read-only — the value is displayed but cannot be edited. The value is still submitted with the form.
|
|
2151
2151
|
* @default false
|
|
2152
2152
|
*/
|
|
2153
2153
|
readOnly?: boolean;
|
|
2154
2154
|
/**
|
|
2155
|
-
*
|
|
2155
|
+
* Marks the field as required — form submission is blocked while this field is empty.
|
|
2156
2156
|
* @default false
|
|
2157
2157
|
*/
|
|
2158
2158
|
required?: boolean;
|
|
2159
2159
|
/**
|
|
2160
|
-
*
|
|
2160
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
2161
2161
|
* @default 'none'
|
|
2162
2162
|
*/
|
|
2163
2163
|
state?: InputEmailState;
|
|
2164
2164
|
/**
|
|
2165
|
-
*
|
|
2165
|
+
* Sets the current email value. When `multiple` is enabled, accepts a comma-separated list of email addresses.
|
|
2166
2166
|
* @default ''
|
|
2167
2167
|
*/
|
|
2168
2168
|
value?: string | null;
|
|
@@ -2207,82 +2207,82 @@ declare class PInputEmail extends BaseComponent implements ControlValueAccessor
|
|
|
2207
2207
|
|
|
2208
2208
|
type PInputMonthProps = {
|
|
2209
2209
|
/**
|
|
2210
|
-
* Provides
|
|
2210
|
+
* Provides the browser with a month/year autofill hint.
|
|
2211
2211
|
*/
|
|
2212
2212
|
autoComplete?: string;
|
|
2213
2213
|
/**
|
|
2214
|
-
*
|
|
2214
|
+
* Reduces the input height and padding for a more compact layout.
|
|
2215
2215
|
* @default false
|
|
2216
2216
|
*/
|
|
2217
2217
|
compact?: boolean;
|
|
2218
2218
|
/**
|
|
2219
|
-
*
|
|
2219
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
2220
2220
|
* @default ''
|
|
2221
2221
|
*/
|
|
2222
2222
|
description?: string;
|
|
2223
2223
|
/**
|
|
2224
|
-
* Disables the
|
|
2224
|
+
* Disables the field, preventing month selection. The value is not submitted with the form.
|
|
2225
2225
|
* @default false
|
|
2226
2226
|
*/
|
|
2227
2227
|
disabled?: boolean;
|
|
2228
2228
|
/**
|
|
2229
|
-
*
|
|
2229
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
2230
2230
|
*/
|
|
2231
2231
|
form?: string;
|
|
2232
2232
|
/**
|
|
2233
|
-
*
|
|
2233
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
2234
2234
|
* @default false
|
|
2235
2235
|
*/
|
|
2236
2236
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
2237
2237
|
/**
|
|
2238
|
-
*
|
|
2238
|
+
* Sets the visible label text displayed above the input field.
|
|
2239
2239
|
* @default ''
|
|
2240
2240
|
*/
|
|
2241
2241
|
label?: string;
|
|
2242
2242
|
/**
|
|
2243
|
-
* @experimental
|
|
2243
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
2244
2244
|
* @default false
|
|
2245
2245
|
*/
|
|
2246
2246
|
loading?: boolean;
|
|
2247
2247
|
/**
|
|
2248
|
-
*
|
|
2248
|
+
* Sets the latest selectable month in YYYY-MM format. Months after this are disabled in the picker.
|
|
2249
2249
|
*/
|
|
2250
2250
|
max?: string;
|
|
2251
2251
|
/**
|
|
2252
|
-
*
|
|
2252
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
2253
2253
|
* @default ''
|
|
2254
2254
|
*/
|
|
2255
2255
|
message?: string;
|
|
2256
2256
|
/**
|
|
2257
|
-
*
|
|
2257
|
+
* Sets the earliest selectable month in YYYY-MM format. Months before this are disabled in the picker.
|
|
2258
2258
|
*/
|
|
2259
2259
|
min?: string;
|
|
2260
2260
|
/**
|
|
2261
|
-
*
|
|
2261
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
2262
2262
|
*/
|
|
2263
2263
|
name: string;
|
|
2264
2264
|
/**
|
|
2265
|
-
*
|
|
2265
|
+
* Makes the field read-only — the value is displayed but cannot be changed. The value is still submitted with the form.
|
|
2266
2266
|
* @default false
|
|
2267
2267
|
*/
|
|
2268
2268
|
readOnly?: boolean;
|
|
2269
2269
|
/**
|
|
2270
|
-
*
|
|
2270
|
+
* Marks the field as required — form submission is blocked while no month is selected.
|
|
2271
2271
|
* @default false
|
|
2272
2272
|
*/
|
|
2273
2273
|
required?: boolean;
|
|
2274
2274
|
/**
|
|
2275
|
-
*
|
|
2275
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
2276
2276
|
* @default 'none'
|
|
2277
2277
|
*/
|
|
2278
2278
|
state?: InputMonthState;
|
|
2279
2279
|
/**
|
|
2280
|
-
*
|
|
2280
|
+
* Sets the stepping interval in months (e.g. `1` for monthly, `12` for annual).
|
|
2281
2281
|
* @default 1
|
|
2282
2282
|
*/
|
|
2283
2283
|
step?: number;
|
|
2284
2284
|
/**
|
|
2285
|
-
*
|
|
2285
|
+
* Sets the current month value in YYYY-MM format (e.g. `2025-07`).
|
|
2286
2286
|
* @default ''
|
|
2287
2287
|
*/
|
|
2288
2288
|
value?: string | null;
|
|
@@ -2324,92 +2324,92 @@ declare class PInputMonth extends BaseComponent implements ControlValueAccessor
|
|
|
2324
2324
|
|
|
2325
2325
|
type PInputNumberProps = {
|
|
2326
2326
|
/**
|
|
2327
|
-
* Provides
|
|
2327
|
+
* Provides the browser with a data type hint to enable relevant autofill suggestions (e.g. `autocomplete='postal-code'`).
|
|
2328
2328
|
*/
|
|
2329
2329
|
autoComplete?: string;
|
|
2330
2330
|
/**
|
|
2331
|
-
*
|
|
2331
|
+
* Reduces the input height and padding for a more compact layout.
|
|
2332
2332
|
* @default false
|
|
2333
2333
|
*/
|
|
2334
2334
|
compact?: boolean;
|
|
2335
2335
|
/**
|
|
2336
|
-
*
|
|
2336
|
+
* Shows increment/decrement spin buttons inside the field to adjust the numeric value by clicking.
|
|
2337
2337
|
* @default false
|
|
2338
2338
|
*/
|
|
2339
2339
|
controls?: boolean;
|
|
2340
2340
|
/**
|
|
2341
|
-
*
|
|
2341
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
2342
2342
|
* @default ''
|
|
2343
2343
|
*/
|
|
2344
2344
|
description?: string;
|
|
2345
2345
|
/**
|
|
2346
|
-
* Disables the input
|
|
2346
|
+
* Disables the field, preventing all input. The value is not submitted with the form.
|
|
2347
2347
|
* @default false
|
|
2348
2348
|
*/
|
|
2349
2349
|
disabled?: boolean;
|
|
2350
2350
|
/**
|
|
2351
|
-
*
|
|
2351
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
2352
2352
|
*/
|
|
2353
2353
|
form?: string;
|
|
2354
2354
|
/**
|
|
2355
|
-
*
|
|
2355
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
2356
2356
|
* @default false
|
|
2357
2357
|
*/
|
|
2358
2358
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
2359
2359
|
/**
|
|
2360
|
-
*
|
|
2360
|
+
* Sets the visible label text displayed above the input field.
|
|
2361
2361
|
* @default ''
|
|
2362
2362
|
*/
|
|
2363
2363
|
label?: string;
|
|
2364
2364
|
/**
|
|
2365
|
-
* @experimental
|
|
2365
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
2366
2366
|
* @default false
|
|
2367
2367
|
*/
|
|
2368
2368
|
loading?: boolean;
|
|
2369
2369
|
/**
|
|
2370
|
-
*
|
|
2370
|
+
* Sets the maximum allowed numeric value. Values above this are invalid.
|
|
2371
2371
|
*/
|
|
2372
2372
|
max?: number;
|
|
2373
2373
|
/**
|
|
2374
|
-
*
|
|
2374
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
2375
2375
|
* @default ''
|
|
2376
2376
|
*/
|
|
2377
2377
|
message?: string;
|
|
2378
2378
|
/**
|
|
2379
|
-
*
|
|
2379
|
+
* Sets the minimum allowed numeric value. Values below this are invalid.
|
|
2380
2380
|
*/
|
|
2381
2381
|
min?: number;
|
|
2382
2382
|
/**
|
|
2383
|
-
*
|
|
2383
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
2384
2384
|
*/
|
|
2385
2385
|
name: string;
|
|
2386
2386
|
/**
|
|
2387
|
-
*
|
|
2387
|
+
* Sets placeholder text shown inside the field when it is empty, to hint at the expected format.
|
|
2388
2388
|
* @default ''
|
|
2389
2389
|
*/
|
|
2390
2390
|
placeholder?: string;
|
|
2391
2391
|
/**
|
|
2392
|
-
*
|
|
2392
|
+
* Makes the field read-only — the value is displayed but cannot be edited. The value is still submitted with the form.
|
|
2393
2393
|
* @default false
|
|
2394
2394
|
*/
|
|
2395
2395
|
readOnly?: boolean;
|
|
2396
2396
|
/**
|
|
2397
|
-
*
|
|
2397
|
+
* Marks the field as required — form submission is blocked while this field is empty.
|
|
2398
2398
|
* @default false
|
|
2399
2399
|
*/
|
|
2400
2400
|
required?: boolean;
|
|
2401
2401
|
/**
|
|
2402
|
-
*
|
|
2402
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
2403
2403
|
* @default 'none'
|
|
2404
2404
|
*/
|
|
2405
2405
|
state?: InputNumberState;
|
|
2406
2406
|
/**
|
|
2407
|
-
*
|
|
2407
|
+
* Sets the stepping granularity — the value must be a multiple of this number. Also controls step button increment size.
|
|
2408
2408
|
* @default 1
|
|
2409
2409
|
*/
|
|
2410
2410
|
step?: number;
|
|
2411
2411
|
/**
|
|
2412
|
-
*
|
|
2412
|
+
* Sets the current numeric value of the field.
|
|
2413
2413
|
* @default ''
|
|
2414
2414
|
*/
|
|
2415
2415
|
value?: string | number | null;
|
|
@@ -2453,87 +2453,87 @@ declare class PInputNumber extends BaseComponent implements ControlValueAccessor
|
|
|
2453
2453
|
|
|
2454
2454
|
type PInputPasswordProps = {
|
|
2455
2455
|
/**
|
|
2456
|
-
* Provides
|
|
2456
|
+
* Provides the browser with a password autofill hint (e.g. `autocomplete='current-password'` or `autocomplete='new-password'`).
|
|
2457
2457
|
*/
|
|
2458
2458
|
autoComplete?: string;
|
|
2459
2459
|
/**
|
|
2460
|
-
*
|
|
2460
|
+
* Reduces the input height and padding for a more compact layout.
|
|
2461
2461
|
* @default false
|
|
2462
2462
|
*/
|
|
2463
2463
|
compact?: boolean;
|
|
2464
2464
|
/**
|
|
2465
|
-
*
|
|
2465
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
2466
2466
|
* @default ''
|
|
2467
2467
|
*/
|
|
2468
2468
|
description?: string;
|
|
2469
2469
|
/**
|
|
2470
|
-
* Disables the input
|
|
2470
|
+
* Disables the field, preventing all input. The value is not submitted with the form.
|
|
2471
2471
|
* @default false
|
|
2472
2472
|
*/
|
|
2473
2473
|
disabled?: boolean;
|
|
2474
2474
|
/**
|
|
2475
|
-
*
|
|
2475
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
2476
2476
|
*/
|
|
2477
2477
|
form?: string;
|
|
2478
2478
|
/**
|
|
2479
|
-
*
|
|
2479
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
2480
2480
|
* @default false
|
|
2481
2481
|
*/
|
|
2482
2482
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
2483
2483
|
/**
|
|
2484
|
-
*
|
|
2484
|
+
* Sets the visible label text displayed above the input field.
|
|
2485
2485
|
* @default ''
|
|
2486
2486
|
*/
|
|
2487
2487
|
label?: string;
|
|
2488
2488
|
/**
|
|
2489
|
-
* @experimental
|
|
2489
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
2490
2490
|
* @default false
|
|
2491
2491
|
*/
|
|
2492
2492
|
loading?: boolean;
|
|
2493
2493
|
/**
|
|
2494
|
-
*
|
|
2494
|
+
* Sets the maximum number of characters the user can enter.
|
|
2495
2495
|
*/
|
|
2496
2496
|
maxLength?: number;
|
|
2497
2497
|
/**
|
|
2498
|
-
*
|
|
2498
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
2499
2499
|
* @default ''
|
|
2500
2500
|
*/
|
|
2501
2501
|
message?: string;
|
|
2502
2502
|
/**
|
|
2503
|
-
*
|
|
2503
|
+
* Sets the minimum number of characters required for the field to be considered valid.
|
|
2504
2504
|
*/
|
|
2505
2505
|
minLength?: number;
|
|
2506
2506
|
/**
|
|
2507
|
-
*
|
|
2507
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
2508
2508
|
*/
|
|
2509
2509
|
name: string;
|
|
2510
2510
|
/**
|
|
2511
|
-
*
|
|
2511
|
+
* Sets placeholder text shown inside the field when it is empty.
|
|
2512
2512
|
* @default ''
|
|
2513
2513
|
*/
|
|
2514
2514
|
placeholder?: string;
|
|
2515
2515
|
/**
|
|
2516
|
-
*
|
|
2516
|
+
* Makes the field read-only — the value is displayed but cannot be edited. The value is still submitted with the form.
|
|
2517
2517
|
* @default false
|
|
2518
2518
|
*/
|
|
2519
2519
|
readOnly?: boolean;
|
|
2520
2520
|
/**
|
|
2521
|
-
*
|
|
2521
|
+
* Marks the field as required — form submission is blocked while this field is empty.
|
|
2522
2522
|
* @default false
|
|
2523
2523
|
*/
|
|
2524
2524
|
required?: boolean;
|
|
2525
2525
|
/**
|
|
2526
|
-
*
|
|
2526
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
2527
2527
|
* @default 'none'
|
|
2528
2528
|
*/
|
|
2529
2529
|
state?: InputPasswordState;
|
|
2530
2530
|
/**
|
|
2531
|
-
*
|
|
2531
|
+
* Shows a toggle button that switches the password between masked and plain text visibility.
|
|
2532
2532
|
* @default false
|
|
2533
2533
|
*/
|
|
2534
2534
|
toggle?: boolean;
|
|
2535
2535
|
/**
|
|
2536
|
-
*
|
|
2536
|
+
* Sets the current password value of the field.
|
|
2537
2537
|
* @default ''
|
|
2538
2538
|
*/
|
|
2539
2539
|
value?: string | null;
|
|
@@ -2576,96 +2576,96 @@ declare class PInputPassword extends BaseComponent implements ControlValueAccess
|
|
|
2576
2576
|
|
|
2577
2577
|
type PInputSearchProps = {
|
|
2578
2578
|
/**
|
|
2579
|
-
*
|
|
2579
|
+
* Sets additional ARIA attributes on the search input, useful for combobox patterns (e.g. `role="combobox"`, `aria-expanded`).
|
|
2580
2580
|
*/
|
|
2581
2581
|
aria?: SelectedAriaAttributes<InputSearchAriaAttribute>;
|
|
2582
2582
|
/**
|
|
2583
|
-
* Provides
|
|
2583
|
+
* Provides the browser with a data type hint to enable relevant autofill suggestions.
|
|
2584
2584
|
*/
|
|
2585
2585
|
autoComplete?: string;
|
|
2586
2586
|
/**
|
|
2587
|
-
*
|
|
2587
|
+
* Shows a clear button (×) inside the field that resets the value to empty when clicked.
|
|
2588
2588
|
* @default false
|
|
2589
2589
|
*/
|
|
2590
2590
|
clear?: boolean;
|
|
2591
2591
|
/**
|
|
2592
|
-
*
|
|
2592
|
+
* Reduces the input height and padding for a more compact layout.
|
|
2593
2593
|
* @default false
|
|
2594
2594
|
*/
|
|
2595
2595
|
compact?: boolean;
|
|
2596
2596
|
/**
|
|
2597
|
-
*
|
|
2597
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
2598
2598
|
* @default ''
|
|
2599
2599
|
*/
|
|
2600
2600
|
description?: string;
|
|
2601
2601
|
/**
|
|
2602
|
-
* Disables the input
|
|
2602
|
+
* Disables the field, preventing all input. The value is not submitted with the form.
|
|
2603
2603
|
* @default false
|
|
2604
2604
|
*/
|
|
2605
2605
|
disabled?: boolean;
|
|
2606
2606
|
/**
|
|
2607
|
-
*
|
|
2607
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
2608
2608
|
*/
|
|
2609
2609
|
form?: string;
|
|
2610
2610
|
/**
|
|
2611
|
-
*
|
|
2611
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
2612
2612
|
* @default false
|
|
2613
2613
|
*/
|
|
2614
2614
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
2615
2615
|
/**
|
|
2616
|
-
*
|
|
2616
|
+
* Shows a magnifying glass icon inside the field as a visual affordance for search input.
|
|
2617
2617
|
* @default false
|
|
2618
2618
|
*/
|
|
2619
2619
|
indicator?: boolean;
|
|
2620
2620
|
/**
|
|
2621
|
-
*
|
|
2621
|
+
* Sets the visible label text displayed above the input field.
|
|
2622
2622
|
* @default ''
|
|
2623
2623
|
*/
|
|
2624
2624
|
label?: string;
|
|
2625
2625
|
/**
|
|
2626
|
-
* @experimental
|
|
2626
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
2627
2627
|
* @default false
|
|
2628
2628
|
*/
|
|
2629
2629
|
loading?: boolean;
|
|
2630
2630
|
/**
|
|
2631
|
-
*
|
|
2631
|
+
* Sets the maximum number of characters the user can enter.
|
|
2632
2632
|
*/
|
|
2633
2633
|
maxLength?: number;
|
|
2634
2634
|
/**
|
|
2635
|
-
*
|
|
2635
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
2636
2636
|
* @default ''
|
|
2637
2637
|
*/
|
|
2638
2638
|
message?: string;
|
|
2639
2639
|
/**
|
|
2640
|
-
*
|
|
2640
|
+
* Sets the minimum number of characters required for the field to be considered valid.
|
|
2641
2641
|
*/
|
|
2642
2642
|
minLength?: number;
|
|
2643
2643
|
/**
|
|
2644
|
-
*
|
|
2644
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
2645
2645
|
*/
|
|
2646
2646
|
name: string;
|
|
2647
2647
|
/**
|
|
2648
|
-
*
|
|
2648
|
+
* Sets placeholder text shown inside the field when it is empty.
|
|
2649
2649
|
* @default ''
|
|
2650
2650
|
*/
|
|
2651
2651
|
placeholder?: string;
|
|
2652
2652
|
/**
|
|
2653
|
-
*
|
|
2653
|
+
* Makes the field read-only — the value is displayed but cannot be edited. The value is still submitted with the form.
|
|
2654
2654
|
* @default false
|
|
2655
2655
|
*/
|
|
2656
2656
|
readOnly?: boolean;
|
|
2657
2657
|
/**
|
|
2658
|
-
*
|
|
2658
|
+
* Marks the field as required — form submission is blocked while this field is empty.
|
|
2659
2659
|
* @default false
|
|
2660
2660
|
*/
|
|
2661
2661
|
required?: boolean;
|
|
2662
2662
|
/**
|
|
2663
|
-
*
|
|
2663
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
2664
2664
|
* @default 'none'
|
|
2665
2665
|
*/
|
|
2666
2666
|
state?: InputSearchState;
|
|
2667
2667
|
/**
|
|
2668
|
-
*
|
|
2668
|
+
* Sets the current search query value of the field.
|
|
2669
2669
|
* @default ''
|
|
2670
2670
|
*/
|
|
2671
2671
|
value?: string | null;
|
|
@@ -2710,91 +2710,91 @@ declare class PInputSearch extends BaseComponent implements ControlValueAccessor
|
|
|
2710
2710
|
|
|
2711
2711
|
type PInputTelProps = {
|
|
2712
2712
|
/**
|
|
2713
|
-
* Provides
|
|
2713
|
+
* Provides the browser with a phone number autofill hint (e.g. `autocomplete='tel'`).
|
|
2714
2714
|
*/
|
|
2715
2715
|
autoComplete?: string;
|
|
2716
2716
|
/**
|
|
2717
|
-
*
|
|
2717
|
+
* Reduces the input height and padding for a more compact layout.
|
|
2718
2718
|
* @default false
|
|
2719
2719
|
*/
|
|
2720
2720
|
compact?: boolean;
|
|
2721
2721
|
/**
|
|
2722
|
-
*
|
|
2722
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
2723
2723
|
* @default ''
|
|
2724
2724
|
*/
|
|
2725
2725
|
description?: string;
|
|
2726
2726
|
/**
|
|
2727
|
-
* Disables the input
|
|
2727
|
+
* Disables the field, preventing all input. The value is not submitted with the form.
|
|
2728
2728
|
* @default false
|
|
2729
2729
|
*/
|
|
2730
2730
|
disabled?: boolean;
|
|
2731
2731
|
/**
|
|
2732
|
-
*
|
|
2732
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
2733
2733
|
*/
|
|
2734
2734
|
form?: string;
|
|
2735
2735
|
/**
|
|
2736
|
-
*
|
|
2736
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
2737
2737
|
* @default false
|
|
2738
2738
|
*/
|
|
2739
2739
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
2740
2740
|
/**
|
|
2741
|
-
*
|
|
2741
|
+
* Shows a phone icon at the start of the field as a visual indicator for telephone input.
|
|
2742
2742
|
* @default false
|
|
2743
2743
|
*/
|
|
2744
2744
|
indicator?: boolean;
|
|
2745
2745
|
/**
|
|
2746
|
-
*
|
|
2746
|
+
* Sets the visible label text displayed above the input field.
|
|
2747
2747
|
* @default ''
|
|
2748
2748
|
*/
|
|
2749
2749
|
label?: string;
|
|
2750
2750
|
/**
|
|
2751
|
-
* @experimental
|
|
2751
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
2752
2752
|
* @default false
|
|
2753
2753
|
*/
|
|
2754
2754
|
loading?: boolean;
|
|
2755
2755
|
/**
|
|
2756
|
-
*
|
|
2756
|
+
* Sets the maximum number of characters the user can enter.
|
|
2757
2757
|
*/
|
|
2758
2758
|
maxLength?: number;
|
|
2759
2759
|
/**
|
|
2760
|
-
*
|
|
2760
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
2761
2761
|
* @default ''
|
|
2762
2762
|
*/
|
|
2763
2763
|
message?: string;
|
|
2764
2764
|
/**
|
|
2765
|
-
*
|
|
2765
|
+
* Sets the minimum number of characters required for the field to be considered valid.
|
|
2766
2766
|
*/
|
|
2767
2767
|
minLength?: number;
|
|
2768
2768
|
/**
|
|
2769
|
-
*
|
|
2769
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
2770
2770
|
*/
|
|
2771
2771
|
name: string;
|
|
2772
2772
|
/**
|
|
2773
|
-
*
|
|
2773
|
+
* Sets a regular expression the entered value must match to be valid. Overrides the browser's default telephone validation.
|
|
2774
2774
|
*/
|
|
2775
2775
|
pattern?: string;
|
|
2776
2776
|
/**
|
|
2777
|
-
*
|
|
2777
|
+
* Sets placeholder text shown inside the field when it is empty, such as an example phone number format.
|
|
2778
2778
|
* @default ''
|
|
2779
2779
|
*/
|
|
2780
2780
|
placeholder?: string;
|
|
2781
2781
|
/**
|
|
2782
|
-
*
|
|
2782
|
+
* Makes the field read-only — the value is displayed but cannot be edited. The value is still submitted with the form.
|
|
2783
2783
|
* @default false
|
|
2784
2784
|
*/
|
|
2785
2785
|
readOnly?: boolean;
|
|
2786
2786
|
/**
|
|
2787
|
-
*
|
|
2787
|
+
* Marks the field as required — form submission is blocked while this field is empty.
|
|
2788
2788
|
* @default false
|
|
2789
2789
|
*/
|
|
2790
2790
|
required?: boolean;
|
|
2791
2791
|
/**
|
|
2792
|
-
*
|
|
2792
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
2793
2793
|
* @default 'none'
|
|
2794
2794
|
*/
|
|
2795
2795
|
state?: InputTelState;
|
|
2796
2796
|
/**
|
|
2797
|
-
*
|
|
2797
|
+
* Sets the current telephone number value of the field.
|
|
2798
2798
|
* @default ''
|
|
2799
2799
|
*/
|
|
2800
2800
|
value?: string | null;
|
|
@@ -2838,91 +2838,91 @@ declare class PInputTel extends BaseComponent implements ControlValueAccessor {
|
|
|
2838
2838
|
|
|
2839
2839
|
type PInputTextProps = {
|
|
2840
2840
|
/**
|
|
2841
|
-
* Provides
|
|
2841
|
+
* Provides the browser with a data type hint to enable relevant autofill suggestions (e.g. `autocomplete='name'`).
|
|
2842
2842
|
*/
|
|
2843
2843
|
autoComplete?: string;
|
|
2844
2844
|
/**
|
|
2845
|
-
*
|
|
2845
|
+
* Reduces the input height and padding for a more compact layout.
|
|
2846
2846
|
* @default false
|
|
2847
2847
|
*/
|
|
2848
2848
|
compact?: boolean;
|
|
2849
2849
|
/**
|
|
2850
|
-
*
|
|
2850
|
+
* Shows a live character counter below the field indicating how many characters have been entered relative to `maxLength`.
|
|
2851
2851
|
* @default false
|
|
2852
2852
|
*/
|
|
2853
2853
|
counter?: boolean;
|
|
2854
2854
|
/**
|
|
2855
|
-
*
|
|
2855
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
2856
2856
|
* @default ''
|
|
2857
2857
|
*/
|
|
2858
2858
|
description?: string;
|
|
2859
2859
|
/**
|
|
2860
|
-
* Disables the input
|
|
2860
|
+
* Disables the field, preventing all input. The value is not submitted with the form.
|
|
2861
2861
|
* @default false
|
|
2862
2862
|
*/
|
|
2863
2863
|
disabled?: boolean;
|
|
2864
2864
|
/**
|
|
2865
|
-
*
|
|
2865
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
2866
2866
|
*/
|
|
2867
2867
|
form?: string;
|
|
2868
2868
|
/**
|
|
2869
|
-
*
|
|
2869
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
2870
2870
|
* @default false
|
|
2871
2871
|
*/
|
|
2872
2872
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
2873
2873
|
/**
|
|
2874
|
-
*
|
|
2874
|
+
* Sets the visible label text displayed above the input field.
|
|
2875
2875
|
* @default ''
|
|
2876
2876
|
*/
|
|
2877
2877
|
label?: string;
|
|
2878
2878
|
/**
|
|
2879
|
-
* @experimental
|
|
2879
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
2880
2880
|
* @default false
|
|
2881
2881
|
*/
|
|
2882
2882
|
loading?: boolean;
|
|
2883
2883
|
/**
|
|
2884
|
-
*
|
|
2884
|
+
* Sets the maximum number of characters the user can enter.
|
|
2885
2885
|
*/
|
|
2886
2886
|
maxLength?: number;
|
|
2887
2887
|
/**
|
|
2888
|
-
*
|
|
2888
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
2889
2889
|
* @default ''
|
|
2890
2890
|
*/
|
|
2891
2891
|
message?: string;
|
|
2892
2892
|
/**
|
|
2893
|
-
*
|
|
2893
|
+
* Sets the minimum number of characters required for the field to be considered valid.
|
|
2894
2894
|
*/
|
|
2895
2895
|
minLength?: number;
|
|
2896
2896
|
/**
|
|
2897
|
-
*
|
|
2897
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
2898
2898
|
*/
|
|
2899
2899
|
name: string;
|
|
2900
2900
|
/**
|
|
2901
|
-
*
|
|
2901
|
+
* Sets placeholder text shown inside the field when it is empty, to hint at the expected format.
|
|
2902
2902
|
* @default ''
|
|
2903
2903
|
*/
|
|
2904
2904
|
placeholder?: string;
|
|
2905
2905
|
/**
|
|
2906
|
-
*
|
|
2906
|
+
* Makes the field read-only — the value is displayed but cannot be edited by the user. The value is still submitted with the form.
|
|
2907
2907
|
* @default false
|
|
2908
2908
|
*/
|
|
2909
2909
|
readOnly?: boolean;
|
|
2910
2910
|
/**
|
|
2911
|
-
*
|
|
2911
|
+
* Marks the field as required — form submission is blocked while this field is empty.
|
|
2912
2912
|
* @default false
|
|
2913
2913
|
*/
|
|
2914
2914
|
required?: boolean;
|
|
2915
2915
|
/**
|
|
2916
|
-
*
|
|
2916
|
+
* Controls whether the browser's built-in spell-checking is enabled for this field.
|
|
2917
2917
|
*/
|
|
2918
2918
|
spellCheck?: boolean;
|
|
2919
2919
|
/**
|
|
2920
|
-
*
|
|
2920
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
2921
2921
|
* @default 'none'
|
|
2922
2922
|
*/
|
|
2923
2923
|
state?: InputTextState;
|
|
2924
2924
|
/**
|
|
2925
|
-
*
|
|
2925
|
+
* Sets the current text value of the input field.
|
|
2926
2926
|
* @default ''
|
|
2927
2927
|
*/
|
|
2928
2928
|
value?: string | number | null;
|
|
@@ -2966,82 +2966,82 @@ declare class PInputText extends BaseComponent implements ControlValueAccessor {
|
|
|
2966
2966
|
|
|
2967
2967
|
type PInputTimeProps = {
|
|
2968
2968
|
/**
|
|
2969
|
-
* Provides
|
|
2969
|
+
* Provides the browser with a time autofill hint.
|
|
2970
2970
|
*/
|
|
2971
2971
|
autoComplete?: string;
|
|
2972
2972
|
/**
|
|
2973
|
-
*
|
|
2973
|
+
* Reduces the input height and padding for a more compact layout.
|
|
2974
2974
|
* @default false
|
|
2975
2975
|
*/
|
|
2976
2976
|
compact?: boolean;
|
|
2977
2977
|
/**
|
|
2978
|
-
*
|
|
2978
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
2979
2979
|
* @default ''
|
|
2980
2980
|
*/
|
|
2981
2981
|
description?: string;
|
|
2982
2982
|
/**
|
|
2983
|
-
* Disables the
|
|
2983
|
+
* Disables the field, preventing time selection. The value is not submitted with the form.
|
|
2984
2984
|
* @default false
|
|
2985
2985
|
*/
|
|
2986
2986
|
disabled?: boolean;
|
|
2987
2987
|
/**
|
|
2988
|
-
*
|
|
2988
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
2989
2989
|
*/
|
|
2990
2990
|
form?: string;
|
|
2991
2991
|
/**
|
|
2992
|
-
*
|
|
2992
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
2993
2993
|
* @default false
|
|
2994
2994
|
*/
|
|
2995
2995
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
2996
2996
|
/**
|
|
2997
|
-
*
|
|
2997
|
+
* Sets the visible label text displayed above the input field.
|
|
2998
2998
|
* @default ''
|
|
2999
2999
|
*/
|
|
3000
3000
|
label?: string;
|
|
3001
3001
|
/**
|
|
3002
|
-
* @experimental
|
|
3002
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
3003
3003
|
* @default false
|
|
3004
3004
|
*/
|
|
3005
3005
|
loading?: boolean;
|
|
3006
3006
|
/**
|
|
3007
|
-
*
|
|
3007
|
+
* Sets the latest selectable time in `hh:mm` or `hh:mm:ss` format. Times after this are disabled in the picker.
|
|
3008
3008
|
*/
|
|
3009
3009
|
max?: string;
|
|
3010
3010
|
/**
|
|
3011
|
-
*
|
|
3011
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
3012
3012
|
* @default ''
|
|
3013
3013
|
*/
|
|
3014
3014
|
message?: string;
|
|
3015
3015
|
/**
|
|
3016
|
-
*
|
|
3016
|
+
* Sets the earliest selectable time in `hh:mm` or `hh:mm:ss` format. Times before this are disabled in the picker.
|
|
3017
3017
|
*/
|
|
3018
3018
|
min?: string;
|
|
3019
3019
|
/**
|
|
3020
|
-
*
|
|
3020
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
3021
3021
|
*/
|
|
3022
3022
|
name: string;
|
|
3023
3023
|
/**
|
|
3024
|
-
*
|
|
3024
|
+
* Makes the field read-only — the value is displayed but cannot be changed. The value is still submitted with the form.
|
|
3025
3025
|
* @default false
|
|
3026
3026
|
*/
|
|
3027
3027
|
readOnly?: boolean;
|
|
3028
3028
|
/**
|
|
3029
|
-
*
|
|
3029
|
+
* Marks the field as required — form submission is blocked while no time is selected.
|
|
3030
3030
|
* @default false
|
|
3031
3031
|
*/
|
|
3032
3032
|
required?: boolean;
|
|
3033
3033
|
/**
|
|
3034
|
-
*
|
|
3034
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
3035
3035
|
* @default 'none'
|
|
3036
3036
|
*/
|
|
3037
3037
|
state?: InputTimeState;
|
|
3038
3038
|
/**
|
|
3039
|
-
*
|
|
3039
|
+
* Sets the stepping interval in seconds. Use `60` for minute-level selection, `1` to also expose seconds.
|
|
3040
3040
|
* @default 60
|
|
3041
3041
|
*/
|
|
3042
3042
|
step?: number;
|
|
3043
3043
|
/**
|
|
3044
|
-
*
|
|
3044
|
+
* Sets the current time value in `hh:mm` or `hh:mm:ss` format (e.g. `14:00`).
|
|
3045
3045
|
* @default ''
|
|
3046
3046
|
*/
|
|
3047
3047
|
value?: string | null;
|
|
@@ -3083,91 +3083,91 @@ declare class PInputTime extends BaseComponent implements ControlValueAccessor {
|
|
|
3083
3083
|
|
|
3084
3084
|
type PInputUrlProps = {
|
|
3085
3085
|
/**
|
|
3086
|
-
* Provides
|
|
3086
|
+
* Provides the browser with a URL autofill hint (e.g. `autocomplete='url'`).
|
|
3087
3087
|
*/
|
|
3088
3088
|
autoComplete?: string;
|
|
3089
3089
|
/**
|
|
3090
|
-
*
|
|
3090
|
+
* Reduces the input height and padding for a more compact layout.
|
|
3091
3091
|
* @default false
|
|
3092
3092
|
*/
|
|
3093
3093
|
compact?: boolean;
|
|
3094
3094
|
/**
|
|
3095
|
-
*
|
|
3095
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
3096
3096
|
* @default ''
|
|
3097
3097
|
*/
|
|
3098
3098
|
description?: string;
|
|
3099
3099
|
/**
|
|
3100
|
-
* Disables the input
|
|
3100
|
+
* Disables the field, preventing all input. The value is not submitted with the form.
|
|
3101
3101
|
* @default false
|
|
3102
3102
|
*/
|
|
3103
3103
|
disabled?: boolean;
|
|
3104
3104
|
/**
|
|
3105
|
-
*
|
|
3105
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
3106
3106
|
*/
|
|
3107
3107
|
form?: string;
|
|
3108
3108
|
/**
|
|
3109
|
-
*
|
|
3109
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
3110
3110
|
* @default false
|
|
3111
3111
|
*/
|
|
3112
3112
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
3113
3113
|
/**
|
|
3114
|
-
*
|
|
3114
|
+
* Shows a URL/link icon at the start of the field as a visual indicator.
|
|
3115
3115
|
* @default false
|
|
3116
3116
|
*/
|
|
3117
3117
|
indicator?: boolean;
|
|
3118
3118
|
/**
|
|
3119
|
-
*
|
|
3119
|
+
* Sets the visible label text displayed above the input field.
|
|
3120
3120
|
* @default ''
|
|
3121
3121
|
*/
|
|
3122
3122
|
label?: string;
|
|
3123
3123
|
/**
|
|
3124
|
-
* @experimental
|
|
3124
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
3125
3125
|
* @default false
|
|
3126
3126
|
*/
|
|
3127
3127
|
loading?: boolean;
|
|
3128
3128
|
/**
|
|
3129
|
-
*
|
|
3129
|
+
* Sets the maximum number of characters the user can enter.
|
|
3130
3130
|
*/
|
|
3131
3131
|
maxLength?: number;
|
|
3132
3132
|
/**
|
|
3133
|
-
*
|
|
3133
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
3134
3134
|
* @default ''
|
|
3135
3135
|
*/
|
|
3136
3136
|
message?: string;
|
|
3137
3137
|
/**
|
|
3138
|
-
*
|
|
3138
|
+
* Sets the minimum number of characters required for the field to be considered valid.
|
|
3139
3139
|
*/
|
|
3140
3140
|
minLength?: number;
|
|
3141
3141
|
/**
|
|
3142
|
-
*
|
|
3142
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
3143
3143
|
*/
|
|
3144
3144
|
name: string;
|
|
3145
3145
|
/**
|
|
3146
|
-
*
|
|
3146
|
+
* Sets a regular expression the entered value must match to be valid. Overrides the browser's default URL validation.
|
|
3147
3147
|
*/
|
|
3148
3148
|
pattern?: string;
|
|
3149
3149
|
/**
|
|
3150
|
-
*
|
|
3150
|
+
* Sets placeholder text shown inside the field when it is empty, such as an example URL.
|
|
3151
3151
|
* @default ''
|
|
3152
3152
|
*/
|
|
3153
3153
|
placeholder?: string;
|
|
3154
3154
|
/**
|
|
3155
|
-
*
|
|
3155
|
+
* Makes the field read-only — the value is displayed but cannot be edited. The value is still submitted with the form.
|
|
3156
3156
|
* @default false
|
|
3157
3157
|
*/
|
|
3158
3158
|
readOnly?: boolean;
|
|
3159
3159
|
/**
|
|
3160
|
-
*
|
|
3160
|
+
* Marks the field as required — form submission is blocked while this field is empty.
|
|
3161
3161
|
* @default false
|
|
3162
3162
|
*/
|
|
3163
3163
|
required?: boolean;
|
|
3164
3164
|
/**
|
|
3165
|
-
*
|
|
3165
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
3166
3166
|
* @default 'none'
|
|
3167
3167
|
*/
|
|
3168
3168
|
state?: InputUrlState;
|
|
3169
3169
|
/**
|
|
3170
|
-
*
|
|
3170
|
+
* Sets the current URL value. Must be an absolute URL (e.g. `https://porsche.com`) to pass browser validation.
|
|
3171
3171
|
* @default ''
|
|
3172
3172
|
*/
|
|
3173
3173
|
value?: string | null;
|
|
@@ -3211,82 +3211,82 @@ declare class PInputUrl extends BaseComponent implements ControlValueAccessor {
|
|
|
3211
3211
|
|
|
3212
3212
|
type PInputWeekProps = {
|
|
3213
3213
|
/**
|
|
3214
|
-
* Provides
|
|
3214
|
+
* Provides the browser with a week/year autofill hint.
|
|
3215
3215
|
*/
|
|
3216
3216
|
autoComplete?: string;
|
|
3217
3217
|
/**
|
|
3218
|
-
*
|
|
3218
|
+
* Reduces the input height and padding for a more compact layout.
|
|
3219
3219
|
* @default false
|
|
3220
3220
|
*/
|
|
3221
3221
|
compact?: boolean;
|
|
3222
3222
|
/**
|
|
3223
|
-
*
|
|
3223
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
3224
3224
|
* @default ''
|
|
3225
3225
|
*/
|
|
3226
3226
|
description?: string;
|
|
3227
3227
|
/**
|
|
3228
|
-
* Disables the
|
|
3228
|
+
* Disables the field, preventing week selection. The value is not submitted with the form.
|
|
3229
3229
|
* @default false
|
|
3230
3230
|
*/
|
|
3231
3231
|
disabled?: boolean;
|
|
3232
3232
|
/**
|
|
3233
|
-
*
|
|
3233
|
+
* Associates the field with a form element by its ID when the field is not nested directly inside it.
|
|
3234
3234
|
*/
|
|
3235
3235
|
form?: string;
|
|
3236
3236
|
/**
|
|
3237
|
-
*
|
|
3237
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
3238
3238
|
* @default false
|
|
3239
3239
|
*/
|
|
3240
3240
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
3241
3241
|
/**
|
|
3242
|
-
*
|
|
3242
|
+
* Sets the visible label text displayed above the input field.
|
|
3243
3243
|
* @default ''
|
|
3244
3244
|
*/
|
|
3245
3245
|
label?: string;
|
|
3246
3246
|
/**
|
|
3247
|
-
* @experimental
|
|
3247
|
+
* @experimental Disables the field and displays a loading spinner to indicate an ongoing operation.
|
|
3248
3248
|
* @default false
|
|
3249
3249
|
*/
|
|
3250
3250
|
loading?: boolean;
|
|
3251
3251
|
/**
|
|
3252
|
-
*
|
|
3252
|
+
* Sets the latest selectable week in YYYY-Www format. Weeks after this are disabled in the picker.
|
|
3253
3253
|
*/
|
|
3254
3254
|
max?: string;
|
|
3255
3255
|
/**
|
|
3256
|
-
*
|
|
3256
|
+
* Sets the validation feedback message displayed below the field when `state` is `success` or `error`.
|
|
3257
3257
|
* @default ''
|
|
3258
3258
|
*/
|
|
3259
3259
|
message?: string;
|
|
3260
3260
|
/**
|
|
3261
|
-
*
|
|
3261
|
+
* Sets the earliest selectable week in YYYY-Www format. Weeks before this are disabled in the picker.
|
|
3262
3262
|
*/
|
|
3263
3263
|
min?: string;
|
|
3264
3264
|
/**
|
|
3265
|
-
*
|
|
3265
|
+
* Sets the name submitted with the form data to identify this field's value on the server.
|
|
3266
3266
|
*/
|
|
3267
3267
|
name: string;
|
|
3268
3268
|
/**
|
|
3269
|
-
*
|
|
3269
|
+
* Makes the field read-only — the value is displayed but cannot be changed. The value is still submitted with the form.
|
|
3270
3270
|
* @default false
|
|
3271
3271
|
*/
|
|
3272
3272
|
readOnly?: boolean;
|
|
3273
3273
|
/**
|
|
3274
|
-
*
|
|
3274
|
+
* Marks the field as required — form submission is blocked while no week is selected.
|
|
3275
3275
|
* @default false
|
|
3276
3276
|
*/
|
|
3277
3277
|
required?: boolean;
|
|
3278
3278
|
/**
|
|
3279
|
-
*
|
|
3279
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
3280
3280
|
* @default 'none'
|
|
3281
3281
|
*/
|
|
3282
3282
|
state?: InputWeekState;
|
|
3283
3283
|
/**
|
|
3284
|
-
*
|
|
3284
|
+
* Sets the stepping interval in weeks.
|
|
3285
3285
|
* @default 1
|
|
3286
3286
|
*/
|
|
3287
3287
|
step?: number;
|
|
3288
3288
|
/**
|
|
3289
|
-
*
|
|
3289
|
+
* Sets the current ISO week value in YYYY-Www format (e.g. `2025-W27`).
|
|
3290
3290
|
* @default ''
|
|
3291
3291
|
*/
|
|
3292
3292
|
value?: string | null;
|
|
@@ -3328,55 +3328,55 @@ declare class PInputWeek extends BaseComponent implements ControlValueAccessor {
|
|
|
3328
3328
|
|
|
3329
3329
|
type PMultiSelectProps = {
|
|
3330
3330
|
/**
|
|
3331
|
-
*
|
|
3331
|
+
* Reduces the control height and padding for a more compact layout.
|
|
3332
3332
|
* @default false
|
|
3333
3333
|
*/
|
|
3334
3334
|
compact?: boolean;
|
|
3335
3335
|
/**
|
|
3336
|
-
*
|
|
3336
|
+
* Sets a supplementary description displayed below the label to provide additional context.
|
|
3337
3337
|
* @default ''
|
|
3338
3338
|
*/
|
|
3339
3339
|
description?: string;
|
|
3340
3340
|
/**
|
|
3341
|
-
* Disables the multi-select
|
|
3341
|
+
* Disables the multi-select, preventing all interaction. Selected values are not submitted with the form.
|
|
3342
3342
|
* @default false
|
|
3343
3343
|
*/
|
|
3344
3344
|
disabled?: boolean;
|
|
3345
3345
|
/**
|
|
3346
|
-
*
|
|
3346
|
+
* Controls whether the dropdown opens upward (`up`) or downward (`down`), or decides automatically (`auto`).
|
|
3347
3347
|
* @default 'auto'
|
|
3348
3348
|
*/
|
|
3349
3349
|
dropdownDirection?: MultiSelectDropdownDirection;
|
|
3350
3350
|
/**
|
|
3351
|
-
*
|
|
3351
|
+
* Associates the multi-select with a form element by its ID when not directly nested inside it.
|
|
3352
3352
|
*/
|
|
3353
3353
|
form?: string;
|
|
3354
3354
|
/**
|
|
3355
|
-
*
|
|
3355
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
3356
3356
|
* @default false
|
|
3357
3357
|
*/
|
|
3358
3358
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
3359
3359
|
/**
|
|
3360
|
-
*
|
|
3360
|
+
* Sets the visible label text displayed above the multi-select control.
|
|
3361
3361
|
* @default ''
|
|
3362
3362
|
*/
|
|
3363
3363
|
label?: string;
|
|
3364
3364
|
/**
|
|
3365
|
-
*
|
|
3365
|
+
* Sets the validation feedback message displayed below the control when `state` is `success` or `error`.
|
|
3366
3366
|
* @default ''
|
|
3367
3367
|
*/
|
|
3368
3368
|
message?: string;
|
|
3369
3369
|
/**
|
|
3370
|
-
*
|
|
3370
|
+
* Sets the name submitted with the form data to identify the selected values on the server.
|
|
3371
3371
|
*/
|
|
3372
3372
|
name: string;
|
|
3373
3373
|
/**
|
|
3374
|
-
*
|
|
3374
|
+
* Marks the multi-select as required — form submission is blocked unless at least one option is selected.
|
|
3375
3375
|
* @default false
|
|
3376
3376
|
*/
|
|
3377
3377
|
required?: boolean;
|
|
3378
3378
|
/**
|
|
3379
|
-
*
|
|
3379
|
+
* Sets the validation state, controlling the visual appearance and style of the feedback message (`none`, `success`, `error`).
|
|
3380
3380
|
* @default 'none'
|
|
3381
3381
|
*/
|
|
3382
3382
|
state?: MultiSelectState;
|
|
@@ -3418,70 +3418,70 @@ declare class PMultiSelect extends BaseComponent implements ControlValueAccessor
|
|
|
3418
3418
|
|
|
3419
3419
|
type PPinCodeProps = {
|
|
3420
3420
|
/**
|
|
3421
|
-
*
|
|
3421
|
+
* Reduces the pin code field height and spacing for use in dense layouts where vertical space is limited.
|
|
3422
3422
|
* @default false
|
|
3423
3423
|
*/
|
|
3424
3424
|
compact?: boolean;
|
|
3425
3425
|
/**
|
|
3426
|
-
*
|
|
3426
|
+
* Sets a supplementary description displayed below the label to give users additional guidance about the pin code.
|
|
3427
3427
|
* @default ''
|
|
3428
3428
|
*/
|
|
3429
3429
|
description?: string;
|
|
3430
3430
|
/**
|
|
3431
|
-
*
|
|
3431
|
+
* Prevents user interaction with all pin code fields and blocks events while the component is disabled.
|
|
3432
3432
|
* @default false
|
|
3433
3433
|
*/
|
|
3434
3434
|
disabled?: boolean;
|
|
3435
3435
|
/**
|
|
3436
|
-
*
|
|
3436
|
+
* Associates the pin code with a form element by its ID when it is not a direct descendant of that form.
|
|
3437
3437
|
*/
|
|
3438
3438
|
form?: string;
|
|
3439
3439
|
/**
|
|
3440
|
-
*
|
|
3440
|
+
* Hides the visible label and description while keeping them accessible to screen readers. Supports responsive breakpoint values.
|
|
3441
3441
|
* @default false
|
|
3442
3442
|
*/
|
|
3443
3443
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
3444
3444
|
/**
|
|
3445
|
-
*
|
|
3445
|
+
* Sets the visible label text displayed above the pin code fields to identify their purpose.
|
|
3446
3446
|
* @default ''
|
|
3447
3447
|
*/
|
|
3448
3448
|
label?: string;
|
|
3449
3449
|
/**
|
|
3450
|
-
*
|
|
3450
|
+
* Sets the number of individual input fields rendered, determining how many characters the pin code consists of.
|
|
3451
3451
|
* @default 4
|
|
3452
3452
|
*/
|
|
3453
3453
|
length?: PinCodeLength;
|
|
3454
3454
|
/**
|
|
3455
|
-
* Disables the
|
|
3455
|
+
* Disables the pin code fields and shows a loading spinner to indicate an ongoing background operation.
|
|
3456
3456
|
* @default false
|
|
3457
3457
|
*/
|
|
3458
3458
|
loading?: boolean;
|
|
3459
3459
|
/**
|
|
3460
|
-
*
|
|
3460
|
+
* Sets the validation feedback message displayed below the pin code when `state` is `success` or `error`.
|
|
3461
3461
|
* @default ''
|
|
3462
3462
|
*/
|
|
3463
3463
|
message?: string;
|
|
3464
3464
|
/**
|
|
3465
|
-
*
|
|
3465
|
+
* Sets the name of the control submitted with the form data to identify the pin code value on the server.
|
|
3466
3466
|
*/
|
|
3467
3467
|
name?: string;
|
|
3468
3468
|
/**
|
|
3469
|
-
* Marks the
|
|
3469
|
+
* Marks the pin code as required so the form cannot be submitted until all fields are filled.
|
|
3470
3470
|
* @default false
|
|
3471
3471
|
*/
|
|
3472
3472
|
required?: boolean;
|
|
3473
3473
|
/**
|
|
3474
|
-
*
|
|
3474
|
+
* Sets the validation state of the pin code, which controls its visual appearance and feedback message style (`none`, `success`, `error`).
|
|
3475
3475
|
* @default 'none'
|
|
3476
3476
|
*/
|
|
3477
3477
|
state?: PinCodeState;
|
|
3478
3478
|
/**
|
|
3479
|
-
*
|
|
3479
|
+
* Controls whether the individual input fields mask their content as password dots (`password`) or show digits (`number`).
|
|
3480
3480
|
* @default 'number'
|
|
3481
3481
|
*/
|
|
3482
3482
|
type?: PinCodeType;
|
|
3483
3483
|
/**
|
|
3484
|
-
* Sets the
|
|
3484
|
+
* Sets the current concatenated value of all pin code fields and allows setting the initial value.
|
|
3485
3485
|
* @default ''
|
|
3486
3486
|
*/
|
|
3487
3487
|
value?: string;
|
|
@@ -3519,65 +3519,65 @@ declare class PPinCode extends BaseComponent implements ControlValueAccessor {
|
|
|
3519
3519
|
|
|
3520
3520
|
type PRadioGroupProps = {
|
|
3521
3521
|
/**
|
|
3522
|
-
*
|
|
3522
|
+
* Reduces the spacing between radio options for use in dense layouts where vertical space is limited.
|
|
3523
3523
|
* @default false
|
|
3524
3524
|
*/
|
|
3525
3525
|
compact?: boolean;
|
|
3526
3526
|
/**
|
|
3527
|
-
*
|
|
3527
|
+
* Sets a supplementary description displayed below the label to give users additional guidance about the radio group.
|
|
3528
3528
|
* @default ''
|
|
3529
3529
|
*/
|
|
3530
3530
|
description?: string;
|
|
3531
3531
|
/**
|
|
3532
|
-
*
|
|
3532
|
+
* Sets the layout direction of the radio options. Use `column` to stack them vertically or `row` to arrange them horizontally. Supports responsive breakpoint values.
|
|
3533
3533
|
* @default 'column'
|
|
3534
3534
|
*/
|
|
3535
3535
|
direction?: BreakpointCustomizable<RadioGroupDirection>;
|
|
3536
3536
|
/**
|
|
3537
|
-
* Disables
|
|
3537
|
+
* Disables all radio options in the group, preventing selection and excluding the value from form submissions.
|
|
3538
3538
|
* @default false
|
|
3539
3539
|
*/
|
|
3540
3540
|
disabled?: boolean;
|
|
3541
3541
|
/**
|
|
3542
|
-
*
|
|
3542
|
+
* Associates the radio group with a form element by its ID when the group is not a direct descendant of that form.
|
|
3543
3543
|
*/
|
|
3544
3544
|
form?: string;
|
|
3545
3545
|
/**
|
|
3546
|
-
*
|
|
3546
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
3547
3547
|
* @default false
|
|
3548
3548
|
*/
|
|
3549
3549
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
3550
3550
|
/**
|
|
3551
|
-
*
|
|
3551
|
+
* Sets the visible label text displayed above the radio group to identify the group's purpose.
|
|
3552
3552
|
* @default ''
|
|
3553
3553
|
*/
|
|
3554
3554
|
label?: string;
|
|
3555
3555
|
/**
|
|
3556
|
-
* @experimental
|
|
3556
|
+
* @experimental Disables all radio options and shows a spinner to indicate a background loading operation.
|
|
3557
3557
|
* @default false
|
|
3558
3558
|
*/
|
|
3559
3559
|
loading?: boolean;
|
|
3560
3560
|
/**
|
|
3561
|
-
*
|
|
3561
|
+
* Sets the validation feedback message displayed below the radio group when `state` is `success` or `error`.
|
|
3562
3562
|
* @default ''
|
|
3563
3563
|
*/
|
|
3564
3564
|
message?: string;
|
|
3565
3565
|
/**
|
|
3566
|
-
*
|
|
3566
|
+
* Sets the shared name attribute for all radio buttons in the group, grouping them for mutually exclusive selection.
|
|
3567
3567
|
*/
|
|
3568
3568
|
name: string;
|
|
3569
3569
|
/**
|
|
3570
|
-
*
|
|
3570
|
+
* Marks the radio group as required so the form cannot be submitted until one option is selected.
|
|
3571
3571
|
* @default false
|
|
3572
3572
|
*/
|
|
3573
3573
|
required?: boolean;
|
|
3574
3574
|
/**
|
|
3575
|
-
*
|
|
3575
|
+
* Sets the validation state of the radio group, controlling its visual appearance and feedback message style (`none`, `success`, `error`).
|
|
3576
3576
|
* @default 'none'
|
|
3577
3577
|
*/
|
|
3578
3578
|
state?: RadioGroupState;
|
|
3579
3579
|
/**
|
|
3580
|
-
*
|
|
3580
|
+
* Sets the currently selected value that pre-selects the matching radio option and reflects user changes.
|
|
3581
3581
|
* @default ''
|
|
3582
3582
|
*/
|
|
3583
3583
|
value?: string;
|
|
@@ -3614,65 +3614,65 @@ declare class PRadioGroup extends BaseComponent implements ControlValueAccessor
|
|
|
3614
3614
|
|
|
3615
3615
|
type PSegmentedControlProps = {
|
|
3616
3616
|
/**
|
|
3617
|
-
* Sets the
|
|
3617
|
+
* Sets the number of equal-width columns for the item layout. Use `auto` to distribute items based on their content width. Supports responsive breakpoint values.
|
|
3618
3618
|
* @default 'auto'
|
|
3619
3619
|
*/
|
|
3620
3620
|
columns?: BreakpointCustomizable<SegmentedControlColumns>;
|
|
3621
3621
|
/**
|
|
3622
|
-
*
|
|
3622
|
+
* Reduces the item height and spacing for use in dense layouts where vertical space is limited.
|
|
3623
3623
|
* @default false
|
|
3624
3624
|
*/
|
|
3625
3625
|
compact?: boolean;
|
|
3626
3626
|
/**
|
|
3627
|
-
*
|
|
3627
|
+
* Sets a supplementary description displayed below the label to give users additional context about the segmented control.
|
|
3628
3628
|
* @default ''
|
|
3629
3629
|
*/
|
|
3630
3630
|
description?: string;
|
|
3631
3631
|
/**
|
|
3632
|
-
*
|
|
3632
|
+
* Prevents user interaction with all items in the segmented control and excludes the value from form submissions.
|
|
3633
3633
|
* @default false
|
|
3634
3634
|
*/
|
|
3635
3635
|
disabled?: boolean;
|
|
3636
3636
|
/**
|
|
3637
|
-
*
|
|
3637
|
+
* Associates the segmented control with a form element by its ID when it is not a direct descendant of that form.
|
|
3638
3638
|
*/
|
|
3639
3639
|
form?: string;
|
|
3640
3640
|
/**
|
|
3641
|
-
*
|
|
3641
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
3642
3642
|
* @default false
|
|
3643
3643
|
*/
|
|
3644
3644
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
3645
3645
|
/**
|
|
3646
|
-
*
|
|
3646
|
+
* Sets the visible label text displayed above the segmented control to describe the group of options.
|
|
3647
3647
|
* @default ''
|
|
3648
3648
|
*/
|
|
3649
3649
|
label?: string;
|
|
3650
3650
|
/**
|
|
3651
|
-
*
|
|
3651
|
+
* Sets the validation feedback message displayed below the segmented control when `state` is `success` or `error`.
|
|
3652
3652
|
* @default ''
|
|
3653
3653
|
*/
|
|
3654
3654
|
message?: string;
|
|
3655
3655
|
/**
|
|
3656
|
-
*
|
|
3656
|
+
* Sets the name of the control submitted with the form data to identify the selected value on the server.
|
|
3657
3657
|
*/
|
|
3658
3658
|
name?: string;
|
|
3659
3659
|
/**
|
|
3660
|
-
*
|
|
3660
|
+
* Prevents items from wrapping to new rows and renders them in a single horizontally scrollable row instead.
|
|
3661
3661
|
* @default false
|
|
3662
3662
|
*/
|
|
3663
3663
|
noWrap?: boolean;
|
|
3664
3664
|
/**
|
|
3665
|
-
*
|
|
3665
|
+
* Marks the segmented control as required so the form cannot be submitted until one option is selected.
|
|
3666
3666
|
* @default false
|
|
3667
3667
|
*/
|
|
3668
3668
|
required?: boolean;
|
|
3669
3669
|
/**
|
|
3670
|
-
*
|
|
3670
|
+
* Sets the validation state of the segmented control, controlling its visual appearance and feedback message style (`none`, `success`, `error`).
|
|
3671
3671
|
* @default 'none'
|
|
3672
3672
|
*/
|
|
3673
3673
|
state?: SegmentedControlState;
|
|
3674
3674
|
/**
|
|
3675
|
-
* Sets the
|
|
3675
|
+
* Sets the currently selected item's value and pre-selects the matching option when the component renders.
|
|
3676
3676
|
*/
|
|
3677
3677
|
value?: string | number;
|
|
3678
3678
|
};
|
|
@@ -3708,60 +3708,60 @@ declare class PSegmentedControl extends BaseComponent implements ControlValueAcc
|
|
|
3708
3708
|
|
|
3709
3709
|
type PSelectProps = {
|
|
3710
3710
|
/**
|
|
3711
|
-
*
|
|
3711
|
+
* Reduces the control height and padding for use in dense layouts where vertical space is limited.
|
|
3712
3712
|
* @default false
|
|
3713
3713
|
*/
|
|
3714
3714
|
compact?: boolean;
|
|
3715
3715
|
/**
|
|
3716
|
-
*
|
|
3716
|
+
* Sets a supplementary description displayed below the label to give users additional guidance about the select.
|
|
3717
3717
|
* @default ''
|
|
3718
3718
|
*/
|
|
3719
3719
|
description?: string;
|
|
3720
3720
|
/**
|
|
3721
|
-
*
|
|
3721
|
+
* Prevents user interaction with the select and excludes its value from form submissions.
|
|
3722
3722
|
* @default false
|
|
3723
3723
|
*/
|
|
3724
3724
|
disabled?: boolean;
|
|
3725
3725
|
/**
|
|
3726
|
-
*
|
|
3726
|
+
* Controls whether the dropdown list opens upward (`up`) or downward (`down`), or determines the direction automatically (`auto`).
|
|
3727
3727
|
* @default 'auto'
|
|
3728
3728
|
*/
|
|
3729
3729
|
dropdownDirection?: SelectDropdownDirection;
|
|
3730
3730
|
/**
|
|
3731
|
-
* Shows
|
|
3731
|
+
* Shows a text input inside the dropdown that filters the visible options as the user types. Ignored when the `filter` slot is used.
|
|
3732
3732
|
* @default false
|
|
3733
3733
|
*/
|
|
3734
3734
|
filter?: boolean;
|
|
3735
3735
|
/**
|
|
3736
|
-
*
|
|
3736
|
+
* Associates the select with a form element by its ID when it is not a direct descendant of that form.
|
|
3737
3737
|
*/
|
|
3738
3738
|
form?: string;
|
|
3739
3739
|
/**
|
|
3740
|
-
*
|
|
3740
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
3741
3741
|
* @default false
|
|
3742
3742
|
*/
|
|
3743
3743
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
3744
3744
|
/**
|
|
3745
|
-
*
|
|
3745
|
+
* Sets the visible label text displayed above the select control to identify its purpose.
|
|
3746
3746
|
* @default ''
|
|
3747
3747
|
*/
|
|
3748
3748
|
label?: string;
|
|
3749
3749
|
/**
|
|
3750
|
-
*
|
|
3750
|
+
* Sets the validation feedback message displayed below the select when `state` is `success` or `error`.
|
|
3751
3751
|
* @default ''
|
|
3752
3752
|
*/
|
|
3753
3753
|
message?: string;
|
|
3754
3754
|
/**
|
|
3755
|
-
*
|
|
3755
|
+
* Sets the name of the control submitted with the form data, identifying the selected value on the server.
|
|
3756
3756
|
*/
|
|
3757
3757
|
name: string;
|
|
3758
3758
|
/**
|
|
3759
|
-
*
|
|
3759
|
+
* Marks the select as required so the form cannot be submitted unless a non-empty option is selected.
|
|
3760
3760
|
* @default false
|
|
3761
3761
|
*/
|
|
3762
3762
|
required?: boolean;
|
|
3763
3763
|
/**
|
|
3764
|
-
*
|
|
3764
|
+
* Sets the validation state of the select, which controls its visual appearance and feedback message style (`none`, `success`, `error`).
|
|
3765
3765
|
* @default 'none'
|
|
3766
3766
|
*/
|
|
3767
3767
|
state?: SelectState;
|
|
@@ -3809,101 +3809,101 @@ declare class PTableBody extends BaseComponent {
|
|
|
3809
3809
|
|
|
3810
3810
|
type PTextareaProps = {
|
|
3811
3811
|
/**
|
|
3812
|
-
* Provides
|
|
3812
|
+
* Provides the browser with a hint to enable text autofill suggestions for the textarea (e.g. `autocomplete='on'`).
|
|
3813
3813
|
*/
|
|
3814
3814
|
autoComplete?: string;
|
|
3815
3815
|
/**
|
|
3816
|
-
*
|
|
3816
|
+
* Reduces the textarea's initial height and padding for use in dense layouts where vertical space is limited.
|
|
3817
3817
|
* @default false
|
|
3818
3818
|
*/
|
|
3819
3819
|
compact?: boolean;
|
|
3820
3820
|
/**
|
|
3821
|
-
*
|
|
3821
|
+
* Shows a live character counter below the textarea indicating how many characters the user has typed relative to `maxLength`.
|
|
3822
3822
|
* @default false
|
|
3823
3823
|
*/
|
|
3824
3824
|
counter?: boolean;
|
|
3825
3825
|
/**
|
|
3826
|
-
*
|
|
3826
|
+
* Sets a supplementary description displayed below the label to give users additional guidance about the textarea.
|
|
3827
3827
|
* @default ''
|
|
3828
3828
|
*/
|
|
3829
3829
|
description?: string;
|
|
3830
3830
|
/**
|
|
3831
|
-
*
|
|
3831
|
+
* Prevents user interaction with the textarea and excludes its value from form submissions.
|
|
3832
3832
|
* @default false
|
|
3833
3833
|
*/
|
|
3834
3834
|
disabled?: boolean;
|
|
3835
3835
|
/**
|
|
3836
|
-
*
|
|
3836
|
+
* Associates the textarea with a form element by its ID when the textarea is not a direct descendant of that form.
|
|
3837
3837
|
*/
|
|
3838
3838
|
form?: string;
|
|
3839
3839
|
/**
|
|
3840
|
-
*
|
|
3840
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
3841
3841
|
* @default false
|
|
3842
3842
|
*/
|
|
3843
3843
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
3844
3844
|
/**
|
|
3845
|
-
*
|
|
3845
|
+
* Sets the visible label text displayed above the textarea to identify its purpose.
|
|
3846
3846
|
* @default ''
|
|
3847
3847
|
*/
|
|
3848
3848
|
label?: string;
|
|
3849
3849
|
/**
|
|
3850
|
-
*
|
|
3850
|
+
* Sets the maximum number of characters the user is allowed to enter into the textarea.
|
|
3851
3851
|
*/
|
|
3852
3852
|
maxLength?: number;
|
|
3853
3853
|
/**
|
|
3854
|
-
*
|
|
3854
|
+
* Sets the validation feedback message displayed below the textarea when `state` is `success` or `error`.
|
|
3855
3855
|
* @default ''
|
|
3856
3856
|
*/
|
|
3857
3857
|
message?: string;
|
|
3858
3858
|
/**
|
|
3859
|
-
*
|
|
3859
|
+
* Sets the minimum number of characters required for the textarea's value to pass constraint validation.
|
|
3860
3860
|
*/
|
|
3861
3861
|
minLength?: number;
|
|
3862
3862
|
/**
|
|
3863
|
-
*
|
|
3863
|
+
* Sets the name of the textarea submitted with the form data to identify this field's value on the server.
|
|
3864
3864
|
*/
|
|
3865
3865
|
name: string;
|
|
3866
3866
|
/**
|
|
3867
|
-
*
|
|
3867
|
+
* Sets placeholder text displayed inside the textarea when it is empty to hint at the expected content format.
|
|
3868
3868
|
* @default ''
|
|
3869
3869
|
*/
|
|
3870
3870
|
placeholder?: string;
|
|
3871
3871
|
/**
|
|
3872
|
-
*
|
|
3872
|
+
* Makes the textarea read-only so users cannot modify the value, while still including it in form submissions.
|
|
3873
3873
|
* @default false
|
|
3874
3874
|
*/
|
|
3875
3875
|
readOnly?: boolean;
|
|
3876
3876
|
/**
|
|
3877
|
-
*
|
|
3877
|
+
* Marks the textarea as required so the form cannot be submitted while this field is empty.
|
|
3878
3878
|
* @default false
|
|
3879
3879
|
*/
|
|
3880
3880
|
required?: boolean;
|
|
3881
3881
|
/**
|
|
3882
|
-
* Controls whether the textarea
|
|
3882
|
+
* Controls whether and in which direction the user can resize the textarea (`horizontal`, `vertical`, `both`, or `none`).
|
|
3883
3883
|
* @default 'vertical'
|
|
3884
3884
|
*/
|
|
3885
3885
|
resize?: TextareaResize;
|
|
3886
3886
|
/**
|
|
3887
|
-
*
|
|
3887
|
+
* Sets the initial visible height of the textarea in lines of text. Has no effect when the `--p-textarea-field-sizing` CSS variable is set to `content`.
|
|
3888
3888
|
* @default 7
|
|
3889
3889
|
*/
|
|
3890
3890
|
rows?: number;
|
|
3891
3891
|
/**
|
|
3892
|
-
*
|
|
3892
|
+
* Controls whether the browser's built-in spell-checking and grammar checking is enabled for the textarea content.
|
|
3893
3893
|
*/
|
|
3894
3894
|
spellCheck?: boolean;
|
|
3895
3895
|
/**
|
|
3896
|
-
*
|
|
3896
|
+
* Sets the validation state of the textarea, which controls its visual appearance and feedback message style (`none`, `success`, `error`).
|
|
3897
3897
|
* @default 'none'
|
|
3898
3898
|
*/
|
|
3899
3899
|
state?: TextareaState;
|
|
3900
3900
|
/**
|
|
3901
|
-
*
|
|
3901
|
+
* Sets the current multi-line text value of the textarea and reflects any changes made by the user.
|
|
3902
3902
|
* @default ''
|
|
3903
3903
|
*/
|
|
3904
3904
|
value?: string | null;
|
|
3905
3905
|
/**
|
|
3906
|
-
*
|
|
3906
|
+
* Controls how the submitted text wraps in the form data: `soft` wraps only visually, `hard` inserts line breaks at the textarea width.
|
|
3907
3907
|
* @default 'soft'
|
|
3908
3908
|
*/
|
|
3909
3909
|
wrap?: TextareaWrap;
|
|
@@ -3949,17 +3949,17 @@ declare class PTextarea extends BaseComponent implements ControlValueAccessor {
|
|
|
3949
3949
|
|
|
3950
3950
|
type PAccordionProps = {
|
|
3951
3951
|
/**
|
|
3952
|
-
*
|
|
3952
|
+
* Positions the expand/collapse marker icon at the start or end of the summary section.
|
|
3953
3953
|
* @default 'end'
|
|
3954
3954
|
*/
|
|
3955
3955
|
alignMarker?: AccordionAlignMarker;
|
|
3956
3956
|
/**
|
|
3957
|
-
*
|
|
3957
|
+
* Sets the background color of the accordion panel. Use `frosted` only when placed on images, videos, or gradients.
|
|
3958
3958
|
* @default 'none'
|
|
3959
3959
|
*/
|
|
3960
3960
|
background?: AccordionBackground;
|
|
3961
3961
|
/**
|
|
3962
|
-
*
|
|
3962
|
+
* Reduces padding and spacing for a more compact layout, useful in space-constrained interfaces.
|
|
3963
3963
|
*/
|
|
3964
3964
|
compact?: boolean;
|
|
3965
3965
|
/**
|
|
@@ -4029,37 +4029,37 @@ declare class PAiTag extends BaseComponent {
|
|
|
4029
4029
|
|
|
4030
4030
|
type PBannerProps = {
|
|
4031
4031
|
/**
|
|
4032
|
-
* Sets the description text
|
|
4032
|
+
* Sets the supporting description text shown below the heading.
|
|
4033
4033
|
* @default ''
|
|
4034
4034
|
*/
|
|
4035
4035
|
description?: string;
|
|
4036
4036
|
/**
|
|
4037
|
-
* Shows a dismiss button
|
|
4037
|
+
* Shows a dismiss button so the user can manually close the banner.
|
|
4038
4038
|
* @default true
|
|
4039
4039
|
*/
|
|
4040
4040
|
dismissButton?: boolean;
|
|
4041
4041
|
/**
|
|
4042
|
-
* Sets the heading text of the banner.
|
|
4042
|
+
* Sets the heading text displayed at the top of the banner.
|
|
4043
4043
|
* @default ''
|
|
4044
4044
|
*/
|
|
4045
4045
|
heading?: string;
|
|
4046
4046
|
/**
|
|
4047
|
-
* Sets the heading tag
|
|
4047
|
+
* Sets the HTML heading tag (e.g. h2, h3) to maintain correct document structure for the heading.
|
|
4048
4048
|
* @default 'h5'
|
|
4049
4049
|
*/
|
|
4050
4050
|
headingTag?: BannerHeadingTag;
|
|
4051
4051
|
/**
|
|
4052
|
-
* Controls whether the banner is
|
|
4052
|
+
* Controls whether the banner is visible. Set to `true` to show it and `false` to hide it.
|
|
4053
4053
|
* @default false
|
|
4054
4054
|
*/
|
|
4055
4055
|
open: boolean;
|
|
4056
4056
|
/**
|
|
4057
|
-
* Sets the position of the banner.
|
|
4057
|
+
* Sets the position of the banner on screen — `top` or `bottom`. Supports responsive breakpoint values.
|
|
4058
4058
|
* @default { base: 'bottom', s: 'top' }
|
|
4059
4059
|
*/
|
|
4060
4060
|
position?: BreakpointCustomizable<BannerPosition>;
|
|
4061
4061
|
/**
|
|
4062
|
-
*
|
|
4062
|
+
* Sets the visual state of the banner — controls the icon and color scheme (`info`, `warning`, `error`, `success`).
|
|
4063
4063
|
* @default 'info'
|
|
4064
4064
|
*/
|
|
4065
4065
|
state?: BannerState;
|
|
@@ -4079,57 +4079,57 @@ declare class PBanner extends BaseComponent {
|
|
|
4079
4079
|
|
|
4080
4080
|
type PButtonProps = {
|
|
4081
4081
|
/**
|
|
4082
|
-
* Sets ARIA attributes.
|
|
4082
|
+
* Sets ARIA attributes on the button to improve accessibility for screen readers.
|
|
4083
4083
|
*/
|
|
4084
4084
|
aria?: SelectedAriaAttributes<ButtonAriaAttribute>;
|
|
4085
4085
|
/**
|
|
4086
|
-
*
|
|
4086
|
+
* Reduces the button's height and padding for denser layouts. Supports responsive breakpoint values.
|
|
4087
4087
|
* @default false
|
|
4088
4088
|
*/
|
|
4089
4089
|
compact?: BreakpointCustomizable<boolean>;
|
|
4090
4090
|
/**
|
|
4091
|
-
* Disables the button
|
|
4091
|
+
* Disables the button, preventing all interaction and blocking events.
|
|
4092
4092
|
* @default false
|
|
4093
4093
|
*/
|
|
4094
4094
|
disabled?: boolean;
|
|
4095
4095
|
/**
|
|
4096
|
-
*
|
|
4096
|
+
* Associates the button with a form element by its ID, so it can submit or reset that form even when placed outside of it.
|
|
4097
4097
|
*/
|
|
4098
4098
|
form?: string;
|
|
4099
4099
|
/**
|
|
4100
|
-
*
|
|
4100
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
4101
4101
|
* @default false
|
|
4102
4102
|
*/
|
|
4103
4103
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
4104
4104
|
/**
|
|
4105
|
-
*
|
|
4105
|
+
* Sets the icon displayed inside the button. Use `none` to show no icon.
|
|
4106
4106
|
* @default 'none'
|
|
4107
4107
|
*/
|
|
4108
4108
|
icon?: ButtonIcon;
|
|
4109
4109
|
/**
|
|
4110
|
-
*
|
|
4110
|
+
* Sets a path to a custom SVG icon, used instead of the built-in icon set.
|
|
4111
4111
|
*/
|
|
4112
4112
|
iconSource?: string;
|
|
4113
4113
|
/**
|
|
4114
|
-
* Disables the button and
|
|
4114
|
+
* Disables the button and replaces its content with a loading spinner to indicate an ongoing operation.
|
|
4115
4115
|
* @default false
|
|
4116
4116
|
*/
|
|
4117
4117
|
loading?: boolean;
|
|
4118
4118
|
/**
|
|
4119
|
-
*
|
|
4119
|
+
* Sets the name submitted with the form data when this button triggers form submission.
|
|
4120
4120
|
*/
|
|
4121
4121
|
name?: string;
|
|
4122
4122
|
/**
|
|
4123
|
-
*
|
|
4123
|
+
* Sets the button's HTML type — `submit` sends the form, `reset` clears it, `button` performs no default action.
|
|
4124
4124
|
* @default 'submit'
|
|
4125
4125
|
*/
|
|
4126
4126
|
type?: ButtonType;
|
|
4127
4127
|
/**
|
|
4128
|
-
*
|
|
4128
|
+
* Sets the value submitted with the form data when this button triggers form submission, paired with `name`.
|
|
4129
4129
|
*/
|
|
4130
4130
|
value?: string;
|
|
4131
4131
|
/**
|
|
4132
|
-
*
|
|
4132
|
+
* Sets the visual style variant of the button (e.g. `primary`, `secondary`, `tertiary`).
|
|
4133
4133
|
* @default 'primary'
|
|
4134
4134
|
*/
|
|
4135
4135
|
variant?: ButtonVariant;
|
|
@@ -4153,78 +4153,78 @@ declare class PButton extends BaseComponent {
|
|
|
4153
4153
|
|
|
4154
4154
|
type PButtonPureProps = {
|
|
4155
4155
|
/**
|
|
4156
|
-
*
|
|
4156
|
+
* Visually marks the button as the currently active or selected item, useful for navigation and toggle patterns.
|
|
4157
4157
|
* @default false
|
|
4158
4158
|
*/
|
|
4159
4159
|
active?: boolean;
|
|
4160
4160
|
/**
|
|
4161
|
-
*
|
|
4161
|
+
* Sets the label position relative to the icon — `start` places it before, `end` places it after. Supports responsive breakpoint values.
|
|
4162
4162
|
* @default 'end'
|
|
4163
4163
|
*/
|
|
4164
4164
|
alignLabel?: BreakpointCustomizable<ButtonPureAlignLabel>;
|
|
4165
4165
|
/**
|
|
4166
|
-
* Sets ARIA attributes.
|
|
4166
|
+
* Sets ARIA attributes on the button to improve accessibility for screen readers.
|
|
4167
4167
|
*/
|
|
4168
4168
|
aria?: SelectedAriaAttributes<ButtonPureAriaAttribute>;
|
|
4169
4169
|
/**
|
|
4170
|
-
*
|
|
4170
|
+
* Sets the foreground color of the button's icon and label text.
|
|
4171
4171
|
* @default 'primary'
|
|
4172
4172
|
*/
|
|
4173
4173
|
color?: ButtonPureColor;
|
|
4174
4174
|
/**
|
|
4175
|
-
* Disables the button
|
|
4175
|
+
* Disables the button, preventing all interaction and blocking events.
|
|
4176
4176
|
* @default false
|
|
4177
4177
|
*/
|
|
4178
4178
|
disabled?: boolean;
|
|
4179
4179
|
/**
|
|
4180
|
-
*
|
|
4180
|
+
* Associates the button with a form element by its ID, so it can submit or reset that form even when placed outside of it.
|
|
4181
4181
|
*/
|
|
4182
4182
|
form?: string;
|
|
4183
4183
|
/**
|
|
4184
|
-
*
|
|
4184
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
4185
4185
|
* @default false
|
|
4186
4186
|
*/
|
|
4187
4187
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
4188
4188
|
/**
|
|
4189
|
-
*
|
|
4189
|
+
* Sets the icon displayed next to the label.
|
|
4190
4190
|
* @default 'arrow-right'
|
|
4191
4191
|
*/
|
|
4192
4192
|
icon?: ButtonPureIcon;
|
|
4193
4193
|
/**
|
|
4194
|
-
*
|
|
4194
|
+
* Sets a path to a custom SVG icon, used instead of the built-in icon set.
|
|
4195
4195
|
*/
|
|
4196
4196
|
iconSource?: string;
|
|
4197
4197
|
/**
|
|
4198
|
-
* Disables the button and
|
|
4198
|
+
* Disables the button and replaces its icon with a loading spinner to indicate an ongoing operation.
|
|
4199
4199
|
* @default false
|
|
4200
4200
|
*/
|
|
4201
4201
|
loading?: boolean;
|
|
4202
4202
|
/**
|
|
4203
|
-
*
|
|
4203
|
+
* Sets the name submitted with the form data when this button triggers form submission.
|
|
4204
4204
|
*/
|
|
4205
4205
|
name?: string;
|
|
4206
4206
|
/**
|
|
4207
|
-
*
|
|
4207
|
+
* Sets the font size of the button label. Supports responsive breakpoint values.
|
|
4208
4208
|
* @default 'sm'
|
|
4209
4209
|
*/
|
|
4210
4210
|
size?: BreakpointCustomizable<ButtonPureSize>;
|
|
4211
4211
|
/**
|
|
4212
|
-
*
|
|
4212
|
+
* Expands the space between icon and label to fill the full container width. Supports responsive breakpoint values.
|
|
4213
4213
|
* @default false
|
|
4214
4214
|
*/
|
|
4215
4215
|
stretch?: BreakpointCustomizable<boolean>;
|
|
4216
4216
|
/**
|
|
4217
|
-
*
|
|
4217
|
+
* Sets the button's HTML type — `submit` sends the form, `reset` clears it, `button` performs no default action.
|
|
4218
4218
|
* @default 'submit'
|
|
4219
4219
|
*/
|
|
4220
4220
|
type?: ButtonPureType;
|
|
4221
4221
|
/**
|
|
4222
|
-
*
|
|
4222
|
+
* Adds a text underline to the label to reinforce the button's link-like appearance.
|
|
4223
4223
|
* @default false
|
|
4224
4224
|
*/
|
|
4225
4225
|
underline?: boolean;
|
|
4226
4226
|
/**
|
|
4227
|
-
*
|
|
4227
|
+
* Sets the value submitted with the form data when this button triggers form submission, paired with `name`.
|
|
4228
4228
|
*/
|
|
4229
4229
|
value?: string;
|
|
4230
4230
|
};
|
|
@@ -4251,68 +4251,68 @@ declare class PButtonPure extends BaseComponent {
|
|
|
4251
4251
|
|
|
4252
4252
|
type PButtonTileProps = {
|
|
4253
4253
|
/**
|
|
4254
|
-
*
|
|
4254
|
+
* Controls the vertical placement of the description and button — `top` or `bottom`.
|
|
4255
4255
|
* @default 'bottom'
|
|
4256
4256
|
*/
|
|
4257
4257
|
align?: ButtonTileAlign;
|
|
4258
4258
|
/**
|
|
4259
|
-
* Sets ARIA attributes.
|
|
4259
|
+
* Sets ARIA attributes on the tile's action button to improve accessibility for screen readers.
|
|
4260
4260
|
*/
|
|
4261
4261
|
aria?: SelectedAriaAttributes<ButtonTileAriaAttribute>;
|
|
4262
4262
|
/**
|
|
4263
|
-
*
|
|
4263
|
+
* Sets the width-to-height ratio of the tile media area. Supports responsive breakpoint values.
|
|
4264
4264
|
* @default '4/3'
|
|
4265
4265
|
*/
|
|
4266
4266
|
aspectRatio?: BreakpointCustomizable<ButtonTileAspectRatio>;
|
|
4267
4267
|
/**
|
|
4268
|
-
*
|
|
4268
|
+
* Renders only the icon button without the full label. Supports responsive breakpoint values.
|
|
4269
4269
|
* @default false
|
|
4270
4270
|
*/
|
|
4271
4271
|
compact?: BreakpointCustomizable<boolean>;
|
|
4272
4272
|
/**
|
|
4273
|
-
*
|
|
4273
|
+
* Sets the description text displayed in the tile's content area.
|
|
4274
4274
|
*/
|
|
4275
4275
|
description: string;
|
|
4276
4276
|
/**
|
|
4277
|
-
* Disables the
|
|
4277
|
+
* Disables the tile, preventing button interaction.
|
|
4278
4278
|
* @default false
|
|
4279
4279
|
*/
|
|
4280
4280
|
disabled?: boolean;
|
|
4281
4281
|
/**
|
|
4282
|
-
*
|
|
4282
|
+
* Shows a gradient overlay over the media slot to improve text legibility on bright images or videos.
|
|
4283
4283
|
* @default false
|
|
4284
4284
|
*/
|
|
4285
4285
|
gradient?: boolean;
|
|
4286
4286
|
/**
|
|
4287
|
-
*
|
|
4287
|
+
* Sets the icon displayed in the tile's action button. Use `none` to show no icon.
|
|
4288
4288
|
* @default 'none'
|
|
4289
4289
|
*/
|
|
4290
4290
|
icon?: ButtonTileIcon;
|
|
4291
4291
|
/**
|
|
4292
|
-
*
|
|
4292
|
+
* Sets a path to a custom SVG icon for the action button, used instead of the built-in icon set.
|
|
4293
4293
|
*/
|
|
4294
4294
|
iconSource?: string;
|
|
4295
4295
|
/**
|
|
4296
|
-
*
|
|
4296
|
+
* Sets the accessible label text of the action button rendered inside the tile.
|
|
4297
4297
|
*/
|
|
4298
4298
|
label: string;
|
|
4299
4299
|
/**
|
|
4300
|
-
* Disables the
|
|
4300
|
+
* Disables the tile and shows a loading spinner to indicate an ongoing operation.
|
|
4301
4301
|
* @default false
|
|
4302
4302
|
*/
|
|
4303
4303
|
loading?: boolean;
|
|
4304
4304
|
/**
|
|
4305
|
-
*
|
|
4305
|
+
* Sets the font size of the description text in the tile content area. Supports responsive breakpoint values.
|
|
4306
4306
|
* @default 'medium'
|
|
4307
4307
|
*/
|
|
4308
4308
|
size?: BreakpointCustomizable<ButtonTileSize>;
|
|
4309
4309
|
/**
|
|
4310
|
-
*
|
|
4310
|
+
* Sets the button's HTML type — `submit` sends the form, `reset` clears it, `button` performs no default action.
|
|
4311
4311
|
* @default 'submit'
|
|
4312
4312
|
*/
|
|
4313
4313
|
type?: ButtonTileType;
|
|
4314
4314
|
/**
|
|
4315
|
-
*
|
|
4315
|
+
* Sets the font weight of the description text in the tile content area. Supports responsive breakpoint values.
|
|
4316
4316
|
* @default 'semi-bold'
|
|
4317
4317
|
*/
|
|
4318
4318
|
weight?: BreakpointCustomizable<ButtonTileWeight>;
|
|
@@ -4338,17 +4338,17 @@ declare class PButtonTile extends BaseComponent {
|
|
|
4338
4338
|
|
|
4339
4339
|
type PCanvasProps = {
|
|
4340
4340
|
/**
|
|
4341
|
-
*
|
|
4341
|
+
* Sets the background color of the main content area and automatically applies a matching color to the sidebar.
|
|
4342
4342
|
* @default 'canvas'
|
|
4343
4343
|
*/
|
|
4344
4344
|
background?: CanvasBackground;
|
|
4345
4345
|
/**
|
|
4346
|
-
*
|
|
4346
|
+
* Controls whether the utility sidebar on the end side (right in LTR) is open or collapsed.
|
|
4347
4347
|
* @default false
|
|
4348
4348
|
*/
|
|
4349
4349
|
sidebarEndOpen?: boolean;
|
|
4350
4350
|
/**
|
|
4351
|
-
*
|
|
4351
|
+
* Controls whether the navigation sidebar on the start side (left in LTR) is open or collapsed.
|
|
4352
4352
|
* @default false
|
|
4353
4353
|
*/
|
|
4354
4354
|
sidebarStartOpen?: boolean;
|
|
@@ -4365,77 +4365,77 @@ declare class PCanvas extends BaseComponent {
|
|
|
4365
4365
|
|
|
4366
4366
|
type PCarouselProps = {
|
|
4367
4367
|
/**
|
|
4368
|
-
*
|
|
4368
|
+
* Sets the zero-based index of the currently visible slide. Update this to navigate programmatically.
|
|
4369
4369
|
* @default 0
|
|
4370
4370
|
*/
|
|
4371
4371
|
activeSlideIndex?: number;
|
|
4372
4372
|
/**
|
|
4373
|
-
*
|
|
4373
|
+
* Controls the alignment of custom slotted controls within the header area.
|
|
4374
4374
|
* @default 'auto'
|
|
4375
4375
|
*/
|
|
4376
4376
|
alignControls?: CarouselAlignControls;
|
|
4377
4377
|
/**
|
|
4378
|
-
*
|
|
4378
|
+
* Controls the horizontal alignment of the heading and description.
|
|
4379
4379
|
* @default 'start'
|
|
4380
4380
|
*/
|
|
4381
4381
|
alignHeader?: CarouselAlignHeader;
|
|
4382
4382
|
/**
|
|
4383
|
-
* Sets ARIA attributes.
|
|
4383
|
+
* Sets ARIA attributes on the carousel region element for improved accessibility.
|
|
4384
4384
|
*/
|
|
4385
4385
|
aria?: SelectedAriaAttributes<CarouselAriaAttribute>;
|
|
4386
4386
|
/**
|
|
4387
|
-
*
|
|
4387
|
+
* Sets the description text displayed below the heading for additional context.
|
|
4388
4388
|
*/
|
|
4389
4389
|
description?: string;
|
|
4390
4390
|
/**
|
|
4391
|
-
*
|
|
4391
|
+
* When enabled, each slide is individually focusable and the carousel navigates one slide at a time instead of one page.
|
|
4392
4392
|
* @default false
|
|
4393
4393
|
*/
|
|
4394
4394
|
focusOnCenterSlide?: boolean;
|
|
4395
4395
|
/**
|
|
4396
|
-
*
|
|
4396
|
+
* Shows a gradient fade at the start and end edges to visually indicate more slides beyond the viewport.
|
|
4397
4397
|
* @default false
|
|
4398
4398
|
*/
|
|
4399
4399
|
gradient?: boolean;
|
|
4400
4400
|
/**
|
|
4401
|
-
*
|
|
4401
|
+
* Sets the heading text displayed above the carousel. Also used as the accessible label when no `aria` prop is set.
|
|
4402
4402
|
*/
|
|
4403
4403
|
heading?: string;
|
|
4404
4404
|
/**
|
|
4405
|
-
*
|
|
4405
|
+
* Sets the font size of the carousel heading.
|
|
4406
4406
|
* @default 'x-large'
|
|
4407
4407
|
*/
|
|
4408
4408
|
headingSize?: CarouselHeadingSize;
|
|
4409
4409
|
/**
|
|
4410
|
-
*
|
|
4410
|
+
* Overrides the default label strings used for the previous, next, and page indicators — useful for localization.
|
|
4411
4411
|
*/
|
|
4412
4412
|
intl?: CarouselInternationalization;
|
|
4413
4413
|
/**
|
|
4414
|
-
*
|
|
4414
|
+
* Shows pagination dot indicators below the carousel. Supports responsive breakpoint values.
|
|
4415
4415
|
* @default false
|
|
4416
4416
|
*/
|
|
4417
4417
|
pagination?: BreakpointCustomizable<boolean>;
|
|
4418
4418
|
/**
|
|
4419
|
-
*
|
|
4419
|
+
* Enables infinite looping — navigating past the last slide wraps back to the first, and vice versa.
|
|
4420
4420
|
* @default false
|
|
4421
4421
|
*/
|
|
4422
4422
|
rewind?: boolean;
|
|
4423
4423
|
/**
|
|
4424
|
-
*
|
|
4424
|
+
* Sets the `href` of an in-page skip link that lets keyboard users jump past the carousel slides.
|
|
4425
4425
|
*/
|
|
4426
4426
|
skipLinkTarget?: string;
|
|
4427
4427
|
/**
|
|
4428
|
-
* Sets
|
|
4428
|
+
* Sets how many slides are visible at once. Use `auto` to control each slide's width via CSS. Supports responsive breakpoint values.
|
|
4429
4429
|
* @default 1
|
|
4430
4430
|
*/
|
|
4431
4431
|
slidesPerPage?: BreakpointCustomizable<CarouselSlidesPerPage>;
|
|
4432
4432
|
/**
|
|
4433
|
-
*
|
|
4433
|
+
* Removes whitespace before the first and after the last slide when `focusOnCenterSlide` is enabled.
|
|
4434
4434
|
* @default false
|
|
4435
4435
|
*/
|
|
4436
4436
|
trimSpace?: boolean;
|
|
4437
4437
|
/**
|
|
4438
|
-
*
|
|
4438
|
+
* Sets the maximum width and outer spacing of the carousel, aligned to PDS grid widths.
|
|
4439
4439
|
* @default 'basic'
|
|
4440
4440
|
*/
|
|
4441
4441
|
width?: CarouselWidth;
|
|
@@ -4464,15 +4464,15 @@ declare class PCarousel extends BaseComponent {
|
|
|
4464
4464
|
|
|
4465
4465
|
type PCrestProps = {
|
|
4466
4466
|
/**
|
|
4467
|
-
* Sets ARIA attributes.
|
|
4467
|
+
* Sets ARIA attributes on the anchor element to improve accessibility when the crest is used as a link.
|
|
4468
4468
|
*/
|
|
4469
4469
|
aria?: SelectedAriaAttributes<CrestAriaAttribute>;
|
|
4470
4470
|
/**
|
|
4471
|
-
* When
|
|
4471
|
+
* When set, renders the crest as an anchor element navigating to this URL when clicked.
|
|
4472
4472
|
*/
|
|
4473
4473
|
href?: string;
|
|
4474
4474
|
/**
|
|
4475
|
-
* Specifies where to open the linked
|
|
4475
|
+
* Specifies where to open the linked URL (e.g. `_self`, `_blank`). Only applies when `href` is set.
|
|
4476
4476
|
* @default '_self'
|
|
4477
4477
|
*/
|
|
4478
4478
|
target?: CrestTarget;
|
|
@@ -4487,27 +4487,27 @@ declare class PCrest extends BaseComponent {
|
|
|
4487
4487
|
|
|
4488
4488
|
type PDisplayProps = {
|
|
4489
4489
|
/**
|
|
4490
|
-
*
|
|
4490
|
+
* Sets the horizontal text alignment (`start`, `center`, `end`, or `inherit`).
|
|
4491
4491
|
* @default 'start'
|
|
4492
4492
|
*/
|
|
4493
4493
|
align?: DisplayAlign;
|
|
4494
4494
|
/**
|
|
4495
|
-
*
|
|
4495
|
+
* Sets the text color using PDS color tokens.
|
|
4496
4496
|
* @default 'primary'
|
|
4497
4497
|
*/
|
|
4498
4498
|
color?: DisplayColor;
|
|
4499
4499
|
/**
|
|
4500
|
-
*
|
|
4500
|
+
* Truncates the text with an ellipsis when it overflows the container on a single line.
|
|
4501
4501
|
* @default false
|
|
4502
4502
|
*/
|
|
4503
4503
|
ellipsis?: boolean;
|
|
4504
4504
|
/**
|
|
4505
|
-
*
|
|
4505
|
+
* Sets the visual text size. Supports responsive breakpoint values.
|
|
4506
4506
|
* @default 'large'
|
|
4507
4507
|
*/
|
|
4508
4508
|
size?: BreakpointCustomizable<DisplaySize>;
|
|
4509
4509
|
/**
|
|
4510
|
-
* Sets
|
|
4510
|
+
* Sets the HTML heading tag (h1–h6) for correct document outline placement. When omitted, the tag is inferred from `size`.
|
|
4511
4511
|
*/
|
|
4512
4512
|
tag?: DisplayTag;
|
|
4513
4513
|
};
|
|
@@ -4524,12 +4524,12 @@ declare class PDisplay extends BaseComponent {
|
|
|
4524
4524
|
|
|
4525
4525
|
type PDividerProps = {
|
|
4526
4526
|
/**
|
|
4527
|
-
*
|
|
4527
|
+
* Sets the color of the divider line using PDS contrast tokens.
|
|
4528
4528
|
* @default 'contrast-lower'
|
|
4529
4529
|
*/
|
|
4530
4530
|
color?: DividerColor;
|
|
4531
4531
|
/**
|
|
4532
|
-
*
|
|
4532
|
+
* Sets the orientation of the divider to `horizontal` or `vertical`. Supports responsive breakpoint values.
|
|
4533
4533
|
* @default 'horizontal'
|
|
4534
4534
|
*/
|
|
4535
4535
|
direction?: BreakpointCustomizable<DividerDirection>;
|
|
@@ -4543,15 +4543,15 @@ declare class PDivider extends BaseComponent {
|
|
|
4543
4543
|
|
|
4544
4544
|
type PDrilldownProps = {
|
|
4545
4545
|
/**
|
|
4546
|
-
*
|
|
4546
|
+
* Sets which `p-drilldown-item` (by `identifier`) is currently expanded to show its sub-navigation level.
|
|
4547
4547
|
*/
|
|
4548
4548
|
activeIdentifier?: string | undefined;
|
|
4549
4549
|
/**
|
|
4550
|
-
* Sets ARIA attributes.
|
|
4550
|
+
* Sets ARIA attributes on the drilldown dialog element for improved screen reader accessibility.
|
|
4551
4551
|
*/
|
|
4552
4552
|
aria?: SelectedAriaAttributes<DrilldownAriaAttribute>;
|
|
4553
4553
|
/**
|
|
4554
|
-
*
|
|
4554
|
+
* Controls whether the drilldown navigation panel is visible.
|
|
4555
4555
|
* @default false
|
|
4556
4556
|
*/
|
|
4557
4557
|
open?: boolean;
|
|
@@ -4573,11 +4573,11 @@ type PDrilldownItemProps = {
|
|
|
4573
4573
|
*/
|
|
4574
4574
|
cascade?: boolean;
|
|
4575
4575
|
/**
|
|
4576
|
-
*
|
|
4576
|
+
* Sets the unique identifier matched against the drilldown's `activeIdentifier` to determine if this item is shown.
|
|
4577
4577
|
*/
|
|
4578
4578
|
identifier: string;
|
|
4579
4579
|
/**
|
|
4580
|
-
*
|
|
4580
|
+
* Sets the text used for the back button, sticky header, and cascade button that navigates into this navigation level.
|
|
4581
4581
|
*/
|
|
4582
4582
|
label?: string;
|
|
4583
4583
|
/**
|
|
@@ -4603,28 +4603,28 @@ declare class PDrilldownItem extends BaseComponent {
|
|
|
4603
4603
|
|
|
4604
4604
|
type PDrilldownLinkProps = {
|
|
4605
4605
|
/**
|
|
4606
|
-
*
|
|
4606
|
+
* Visually marks the link as the currently active navigation item, e.g. the current page.
|
|
4607
4607
|
* @default false
|
|
4608
4608
|
*/
|
|
4609
4609
|
active?: boolean;
|
|
4610
4610
|
/**
|
|
4611
|
-
*
|
|
4611
|
+
* Sets ARIA attributes on the link for improved accessibility. Only applies when `href` is set.
|
|
4612
4612
|
*/
|
|
4613
4613
|
aria?: SelectedAriaAttributes<DrilldownLinkAriaAttribute>;
|
|
4614
4614
|
/**
|
|
4615
|
-
* Sets the native `download` attribute
|
|
4615
|
+
* Sets the native `download` attribute to trigger a file download. Only applies when `href` is set.
|
|
4616
4616
|
*/
|
|
4617
4617
|
download?: string;
|
|
4618
4618
|
/**
|
|
4619
|
-
* When
|
|
4619
|
+
* When set, the component renders as an anchor navigating to this URL. Otherwise, provide a slotted anchor element.
|
|
4620
4620
|
*/
|
|
4621
4621
|
href?: string;
|
|
4622
4622
|
/**
|
|
4623
|
-
* Sets the `rel` attribute on the link (
|
|
4623
|
+
* Sets the `rel` attribute on the link element (e.g. `noopener`). Only applies when `href` is set.
|
|
4624
4624
|
*/
|
|
4625
4625
|
rel?: string;
|
|
4626
4626
|
/**
|
|
4627
|
-
*
|
|
4627
|
+
* Specifies where to open the linked URL (e.g. `_self`, `_blank`). Only applies when `href` is set.
|
|
4628
4628
|
* @default '_self'
|
|
4629
4629
|
*/
|
|
4630
4630
|
target?: DrilldownLinkTarget;
|
|
@@ -4642,31 +4642,31 @@ declare class PDrilldownLink extends BaseComponent {
|
|
|
4642
4642
|
|
|
4643
4643
|
type PFieldsetProps = {
|
|
4644
4644
|
/**
|
|
4645
|
-
*
|
|
4645
|
+
* Overrides the ARIA role on the fieldset — use `radiogroup` when grouping radio buttons.
|
|
4646
4646
|
*/
|
|
4647
4647
|
aria?: SelectedAriaRole<"radiogroup">;
|
|
4648
4648
|
/**
|
|
4649
|
-
*
|
|
4649
|
+
* Sets the visible legend text displayed above the grouped form controls.
|
|
4650
4650
|
* @default ''
|
|
4651
4651
|
*/
|
|
4652
4652
|
label?: string;
|
|
4653
4653
|
/**
|
|
4654
|
-
*
|
|
4654
|
+
* Sets the font size of the fieldset label (`small`, `medium`, or `large`).
|
|
4655
4655
|
* @default 'medium'
|
|
4656
4656
|
*/
|
|
4657
4657
|
labelSize?: FieldsetLabelSize;
|
|
4658
4658
|
/**
|
|
4659
|
-
*
|
|
4659
|
+
* Sets the validation feedback message displayed below the fieldset when `state` is `success` or `error`.
|
|
4660
4660
|
* @default ''
|
|
4661
4661
|
*/
|
|
4662
4662
|
message?: string;
|
|
4663
4663
|
/**
|
|
4664
|
-
* Marks the
|
|
4664
|
+
* Marks all controls within the fieldset as required and adds a required indicator to the label.
|
|
4665
4665
|
* @default false
|
|
4666
4666
|
*/
|
|
4667
4667
|
required?: boolean;
|
|
4668
4668
|
/**
|
|
4669
|
-
*
|
|
4669
|
+
* Sets the validation state of the fieldset, controlling the color and style of the feedback message.
|
|
4670
4670
|
* @default 'none'
|
|
4671
4671
|
*/
|
|
4672
4672
|
state?: FieldsetState;
|
|
@@ -4708,26 +4708,26 @@ declare class PFlag extends BaseComponent {
|
|
|
4708
4708
|
|
|
4709
4709
|
type PFlyoutProps = {
|
|
4710
4710
|
/**
|
|
4711
|
-
* Sets ARIA attributes.
|
|
4711
|
+
* Sets ARIA attributes on the flyout dialog element for improved screen reader accessibility.
|
|
4712
4712
|
*/
|
|
4713
4713
|
aria?: SelectedAriaAttributes<FlyoutAriaAttribute>;
|
|
4714
4714
|
/**
|
|
4715
|
-
*
|
|
4715
|
+
* Sets the backdrop style. Use `blur` when background content is irrelevant; use `shading` when users still need visual context.
|
|
4716
4716
|
* @default 'blur'
|
|
4717
4717
|
*/
|
|
4718
4718
|
backdrop?: FlyoutBackdrop;
|
|
4719
4719
|
/**
|
|
4720
|
-
*
|
|
4720
|
+
* Sets the background color of the flyout panel (`canvas` or `surface`).
|
|
4721
4721
|
* @default 'canvas'
|
|
4722
4722
|
*/
|
|
4723
4723
|
background?: FlyoutBackground;
|
|
4724
4724
|
/**
|
|
4725
|
-
*
|
|
4725
|
+
* When enabled, clicking the backdrop will not close the flyout.
|
|
4726
4726
|
* @default false
|
|
4727
4727
|
*/
|
|
4728
4728
|
disableBackdropClick?: boolean;
|
|
4729
4729
|
/**
|
|
4730
|
-
*
|
|
4730
|
+
* Controls footer behavior. `fixed` keeps it anchored at the bottom; `sticky` pins it only when content overflows.
|
|
4731
4731
|
* @default 'sticky'
|
|
4732
4732
|
*/
|
|
4733
4733
|
footerBehavior?: FlyoutFooterBehavior;
|
|
@@ -4737,12 +4737,12 @@ type PFlyoutProps = {
|
|
|
4737
4737
|
*/
|
|
4738
4738
|
fullscreen?: BreakpointCustomizable<boolean>;
|
|
4739
4739
|
/**
|
|
4740
|
-
*
|
|
4740
|
+
* Controls whether the flyout panel is visible.
|
|
4741
4741
|
* @default false
|
|
4742
4742
|
*/
|
|
4743
4743
|
open: boolean;
|
|
4744
4744
|
/**
|
|
4745
|
-
*
|
|
4745
|
+
* Sets the side the flyout slides in from — `start` for left or `end` for right in LTR layouts.
|
|
4746
4746
|
* @default 'end'
|
|
4747
4747
|
*/
|
|
4748
4748
|
position?: FlyoutPosition;
|
|
@@ -4765,36 +4765,36 @@ declare class PFlyout extends BaseComponent {
|
|
|
4765
4765
|
|
|
4766
4766
|
type PHeadingProps = {
|
|
4767
4767
|
/**
|
|
4768
|
-
*
|
|
4768
|
+
* Sets the horizontal text alignment (`start`, `center`, `end`, or `inherit`).
|
|
4769
4769
|
* @default 'start'
|
|
4770
4770
|
*/
|
|
4771
4771
|
align?: HeadingAlign;
|
|
4772
4772
|
/**
|
|
4773
|
-
*
|
|
4773
|
+
* Sets the text color using PDS color tokens.
|
|
4774
4774
|
* @default 'primary'
|
|
4775
4775
|
*/
|
|
4776
4776
|
color?: HeadingColor;
|
|
4777
4777
|
/**
|
|
4778
|
-
*
|
|
4778
|
+
* Truncates the text with an ellipsis when it overflows the container on a single line. Cannot be combined with multi-line content.
|
|
4779
4779
|
* @default false
|
|
4780
4780
|
*/
|
|
4781
4781
|
ellipsis?: boolean;
|
|
4782
4782
|
/**
|
|
4783
|
-
* Controls
|
|
4783
|
+
* Controls hyphenation behavior — `auto` lets the browser decide, `manual` only breaks at `­`, `none` disables it entirely.
|
|
4784
4784
|
* @default 'none'
|
|
4785
4785
|
*/
|
|
4786
4786
|
hyphens?: HeadingHyphens;
|
|
4787
4787
|
/**
|
|
4788
|
-
*
|
|
4788
|
+
* Sets the visual size of the heading. Use `inherit` to derive size from the parent. Supports responsive breakpoint values.
|
|
4789
4789
|
* @default '2xl'
|
|
4790
4790
|
*/
|
|
4791
4791
|
size?: BreakpointCustomizable<HeadingSize>;
|
|
4792
4792
|
/**
|
|
4793
|
-
* Sets the HTML heading tag (h1
|
|
4793
|
+
* Sets the HTML heading tag (h1–h6) for correct document outline placement. When omitted, the tag is inferred from `size`.
|
|
4794
4794
|
*/
|
|
4795
4795
|
tag?: HeadingTag;
|
|
4796
4796
|
/**
|
|
4797
|
-
*
|
|
4797
|
+
* Sets the font weight — `normal`, `semibold`, or `bold`.
|
|
4798
4798
|
* @default 'normal'
|
|
4799
4799
|
*/
|
|
4800
4800
|
weight?: HeadingWeight;
|
|
@@ -4813,26 +4813,26 @@ declare class PHeading extends BaseComponent {
|
|
|
4813
4813
|
|
|
4814
4814
|
type PIconProps = {
|
|
4815
4815
|
/**
|
|
4816
|
-
* Sets ARIA attributes.
|
|
4816
|
+
* Sets ARIA attributes on the icon — use `aria-label` to make the icon meaningful to screen readers when it conveys information.
|
|
4817
4817
|
*/
|
|
4818
4818
|
aria?: SelectedAriaAttributes<IconAriaAttribute>;
|
|
4819
4819
|
/**
|
|
4820
|
-
*
|
|
4820
|
+
* Sets the fill color of the icon using PDS color tokens.
|
|
4821
4821
|
* @default 'primary'
|
|
4822
4822
|
*/
|
|
4823
4823
|
color?: IconColor;
|
|
4824
4824
|
/**
|
|
4825
|
-
*
|
|
4825
|
+
* Selects an icon from the built-in PDS icon library by name (e.g. `arrow-right`, `close`).
|
|
4826
4826
|
* @default 'arrow-right'
|
|
4827
4827
|
*/
|
|
4828
4828
|
name?: IconName;
|
|
4829
4829
|
/**
|
|
4830
|
-
*
|
|
4830
|
+
* Sets the icon size using the PDS typographic scale. Use `inherit` to derive size from the parent element. Supports responsive breakpoint values.
|
|
4831
4831
|
* @default 'sm'
|
|
4832
4832
|
*/
|
|
4833
4833
|
size?: BreakpointCustomizable<IconSize>;
|
|
4834
4834
|
/**
|
|
4835
|
-
*
|
|
4835
|
+
* Sets a path to a custom SVG icon, used instead of the built-in icon library.
|
|
4836
4836
|
*/
|
|
4837
4837
|
source?: string;
|
|
4838
4838
|
};
|
|
@@ -4848,41 +4848,41 @@ declare class PIcon extends BaseComponent {
|
|
|
4848
4848
|
|
|
4849
4849
|
type PInlineNotificationProps = {
|
|
4850
4850
|
/**
|
|
4851
|
-
*
|
|
4851
|
+
* Sets the icon displayed inside the action button using a PDS icon name.
|
|
4852
4852
|
* @default 'arrow-right'
|
|
4853
4853
|
*/
|
|
4854
4854
|
actionIcon?: InlineNotificationActionIcon;
|
|
4855
4855
|
/**
|
|
4856
|
-
*
|
|
4856
|
+
* Sets the label text of the optional action button inside the notification.
|
|
4857
4857
|
*/
|
|
4858
4858
|
actionLabel?: string;
|
|
4859
4859
|
/**
|
|
4860
|
-
* Disables the action button and shows a
|
|
4860
|
+
* Disables the action button and shows a spinner to indicate an ongoing operation.
|
|
4861
4861
|
* @default false
|
|
4862
4862
|
*/
|
|
4863
4863
|
actionLoading?: boolean;
|
|
4864
4864
|
/**
|
|
4865
|
-
*
|
|
4865
|
+
* Sets the supporting description text shown below the heading.
|
|
4866
4866
|
* @default ''
|
|
4867
4867
|
*/
|
|
4868
4868
|
description?: string;
|
|
4869
4869
|
/**
|
|
4870
|
-
*
|
|
4870
|
+
* Shows a dismiss button so the user can manually close the notification.
|
|
4871
4871
|
* @default true
|
|
4872
4872
|
*/
|
|
4873
4873
|
dismissButton?: boolean;
|
|
4874
4874
|
/**
|
|
4875
|
-
*
|
|
4875
|
+
* Sets the heading text displayed at the top of the inline notification.
|
|
4876
4876
|
* @default ''
|
|
4877
4877
|
*/
|
|
4878
4878
|
heading?: string;
|
|
4879
4879
|
/**
|
|
4880
|
-
* Sets
|
|
4880
|
+
* Sets the HTML heading tag (e.g. h2, h3) to maintain correct document structure.
|
|
4881
4881
|
* @default 'h5'
|
|
4882
4882
|
*/
|
|
4883
4883
|
headingTag?: InlineNotificationHeadingTag;
|
|
4884
4884
|
/**
|
|
4885
|
-
*
|
|
4885
|
+
* Sets the visual state — controls the icon and color scheme (`info`, `warning`, `error`, `success`).
|
|
4886
4886
|
* @default 'info'
|
|
4887
4887
|
*/
|
|
4888
4888
|
state?: InlineNotificationState;
|
|
@@ -4904,47 +4904,47 @@ declare class PInlineNotification extends BaseComponent {
|
|
|
4904
4904
|
|
|
4905
4905
|
type PLinkProps = {
|
|
4906
4906
|
/**
|
|
4907
|
-
* Sets ARIA attributes.
|
|
4907
|
+
* Sets ARIA attributes on the link element to improve accessibility for screen readers.
|
|
4908
4908
|
*/
|
|
4909
4909
|
aria?: SelectedAriaAttributes<LinkAriaAttribute>;
|
|
4910
4910
|
/**
|
|
4911
|
-
*
|
|
4911
|
+
* Reduces the link's padding and height for denser layouts. Supports responsive breakpoint values.
|
|
4912
4912
|
* @default false
|
|
4913
4913
|
*/
|
|
4914
4914
|
compact?: BreakpointCustomizable<boolean>;
|
|
4915
4915
|
/**
|
|
4916
|
-
* Sets the native `download` attribute
|
|
4916
|
+
* Sets the native `download` attribute to trigger a file download. Only applies when `href` is set.
|
|
4917
4917
|
*/
|
|
4918
4918
|
download?: string;
|
|
4919
4919
|
/**
|
|
4920
|
-
*
|
|
4920
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
4921
4921
|
* @default false
|
|
4922
4922
|
*/
|
|
4923
4923
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
4924
4924
|
/**
|
|
4925
|
-
* When
|
|
4925
|
+
* When set, the component renders as an anchor navigating to this URL. Otherwise, provide a slotted anchor element.
|
|
4926
4926
|
*/
|
|
4927
4927
|
href?: string;
|
|
4928
4928
|
/**
|
|
4929
|
-
*
|
|
4929
|
+
* Sets the icon displayed next to the link label. Use `none` to show no icon.
|
|
4930
4930
|
* @default 'none'
|
|
4931
4931
|
*/
|
|
4932
4932
|
icon?: LinkIcon;
|
|
4933
4933
|
/**
|
|
4934
|
-
*
|
|
4934
|
+
* Sets a path to a custom SVG icon, used instead of the built-in icon set.
|
|
4935
4935
|
*/
|
|
4936
4936
|
iconSource?: string;
|
|
4937
4937
|
/**
|
|
4938
|
-
* Sets the `rel` attribute on the link.
|
|
4938
|
+
* Sets the `rel` attribute on the link (e.g. `noopener`). Only applies when `href` is set.
|
|
4939
4939
|
*/
|
|
4940
4940
|
rel?: string;
|
|
4941
4941
|
/**
|
|
4942
|
-
* Specifies where to open the linked
|
|
4942
|
+
* Specifies where to open the linked URL (e.g. `_self`, `_blank`). Only applies when `href` is set.
|
|
4943
4943
|
* @default '_self'
|
|
4944
4944
|
*/
|
|
4945
4945
|
target?: LinkTarget;
|
|
4946
4946
|
/**
|
|
4947
|
-
*
|
|
4947
|
+
* Sets the visual style variant of the link (e.g. `primary`, `secondary`, `tertiary`).
|
|
4948
4948
|
* @default 'primary'
|
|
4949
4949
|
*/
|
|
4950
4950
|
variant?: LinkVariant;
|
|
@@ -4966,67 +4966,67 @@ declare class PLink extends BaseComponent {
|
|
|
4966
4966
|
|
|
4967
4967
|
type PLinkPureProps = {
|
|
4968
4968
|
/**
|
|
4969
|
-
*
|
|
4969
|
+
* Visually marks the link as the currently active navigation item, e.g. the current page.
|
|
4970
4970
|
* @default false
|
|
4971
4971
|
*/
|
|
4972
4972
|
active?: boolean;
|
|
4973
4973
|
/**
|
|
4974
|
-
*
|
|
4974
|
+
* Sets the label position relative to the icon — `start` places it before, `end` places it after. Supports responsive breakpoint values.
|
|
4975
4975
|
* @default 'end'
|
|
4976
4976
|
*/
|
|
4977
4977
|
alignLabel?: BreakpointCustomizable<LinkPureAlignLabel>;
|
|
4978
4978
|
/**
|
|
4979
|
-
* Sets ARIA attributes.
|
|
4979
|
+
* Sets ARIA attributes on the link element to improve accessibility for screen readers.
|
|
4980
4980
|
*/
|
|
4981
4981
|
aria?: SelectedAriaAttributes<LinkPureAriaAttribute>;
|
|
4982
4982
|
/**
|
|
4983
|
-
*
|
|
4983
|
+
* Sets the foreground color of the link's icon and label text.
|
|
4984
4984
|
* @default 'primary'
|
|
4985
4985
|
*/
|
|
4986
4986
|
color?: LinkPureColor;
|
|
4987
4987
|
/**
|
|
4988
|
-
* Sets the native `download` attribute
|
|
4988
|
+
* Sets the native `download` attribute to trigger a file download. Only applies when `href` is set.
|
|
4989
4989
|
*/
|
|
4990
4990
|
download?: string;
|
|
4991
4991
|
/**
|
|
4992
|
-
*
|
|
4992
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
4993
4993
|
* @default false
|
|
4994
4994
|
*/
|
|
4995
4995
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
4996
4996
|
/**
|
|
4997
|
-
* When
|
|
4997
|
+
* When set, the component renders as an anchor navigating to this URL. Otherwise, provide a slotted anchor element.
|
|
4998
4998
|
*/
|
|
4999
4999
|
href?: string;
|
|
5000
5000
|
/**
|
|
5001
|
-
*
|
|
5001
|
+
* Sets the icon displayed next to the label.
|
|
5002
5002
|
* @default 'arrow-right'
|
|
5003
5003
|
*/
|
|
5004
5004
|
icon?: LinkPureIcon;
|
|
5005
5005
|
/**
|
|
5006
|
-
*
|
|
5006
|
+
* Sets a path to a custom SVG icon, used instead of the built-in icon set.
|
|
5007
5007
|
*/
|
|
5008
5008
|
iconSource?: string;
|
|
5009
5009
|
/**
|
|
5010
|
-
* Sets the `rel` attribute on the link.
|
|
5010
|
+
* Sets the `rel` attribute on the link (e.g. `noopener`). Only applies when `href` is set.
|
|
5011
5011
|
*/
|
|
5012
5012
|
rel?: string;
|
|
5013
5013
|
/**
|
|
5014
|
-
*
|
|
5014
|
+
* Sets the font size of the link label. Supports responsive breakpoint values.
|
|
5015
5015
|
* @default 'sm'
|
|
5016
5016
|
*/
|
|
5017
5017
|
size?: BreakpointCustomizable<LinkPureSize>;
|
|
5018
5018
|
/**
|
|
5019
|
-
*
|
|
5019
|
+
* Expands the space between icon and label to fill the full container width. Supports responsive breakpoint values.
|
|
5020
5020
|
* @default false
|
|
5021
5021
|
*/
|
|
5022
5022
|
stretch?: BreakpointCustomizable<boolean>;
|
|
5023
5023
|
/**
|
|
5024
|
-
* Specifies where to open the linked
|
|
5024
|
+
* Specifies where to open the linked URL (e.g. `_self`, `_blank`). Only applies when `href` is set.
|
|
5025
5025
|
* @default '_self'
|
|
5026
5026
|
*/
|
|
5027
5027
|
target?: LinkPureTarget;
|
|
5028
5028
|
/**
|
|
5029
|
-
*
|
|
5029
|
+
* Adds a text underline to the label to reinforce its link-like appearance.
|
|
5030
5030
|
* @default false
|
|
5031
5031
|
*/
|
|
5032
5032
|
underline?: boolean;
|
|
@@ -5052,61 +5052,61 @@ declare class PLinkPure extends BaseComponent {
|
|
|
5052
5052
|
|
|
5053
5053
|
type PLinkTileProps = {
|
|
5054
5054
|
/**
|
|
5055
|
-
*
|
|
5055
|
+
* Controls the vertical placement of the description and link — `top` or `bottom`.
|
|
5056
5056
|
* @default 'bottom'
|
|
5057
5057
|
*/
|
|
5058
5058
|
align?: LinkTileAlign;
|
|
5059
5059
|
/**
|
|
5060
|
-
* Sets ARIA attributes.
|
|
5060
|
+
* Sets ARIA attributes on the tile's anchor element to improve accessibility for screen readers.
|
|
5061
5061
|
*/
|
|
5062
5062
|
aria?: SelectedAriaAttributes<LinkTileAriaAttribute>;
|
|
5063
5063
|
/**
|
|
5064
|
-
*
|
|
5064
|
+
* Sets the width-to-height ratio of the tile media area. Supports responsive breakpoint values.
|
|
5065
5065
|
* @default '4/3'
|
|
5066
5066
|
*/
|
|
5067
5067
|
aspectRatio?: BreakpointCustomizable<LinkTileAspectRatio>;
|
|
5068
5068
|
/**
|
|
5069
|
-
*
|
|
5069
|
+
* Renders only the icon link without the full label. Supports responsive breakpoint values.
|
|
5070
5070
|
* @default false
|
|
5071
5071
|
*/
|
|
5072
5072
|
compact?: BreakpointCustomizable<boolean>;
|
|
5073
5073
|
/**
|
|
5074
|
-
*
|
|
5074
|
+
* Sets the description text displayed in the tile's content area.
|
|
5075
5075
|
*/
|
|
5076
5076
|
description: string;
|
|
5077
5077
|
/**
|
|
5078
|
-
* Sets the native `download` attribute
|
|
5078
|
+
* Sets the native `download` attribute to trigger a file download.
|
|
5079
5079
|
*/
|
|
5080
5080
|
download?: string;
|
|
5081
5081
|
/**
|
|
5082
|
-
*
|
|
5082
|
+
* Shows a gradient overlay over the media slot to improve text legibility on bright images or videos.
|
|
5083
5083
|
* @default false
|
|
5084
5084
|
*/
|
|
5085
5085
|
gradient?: boolean;
|
|
5086
5086
|
/**
|
|
5087
|
-
*
|
|
5087
|
+
* Sets the URL the tile's anchor element navigates to when clicked.
|
|
5088
5088
|
*/
|
|
5089
5089
|
href: string;
|
|
5090
5090
|
/**
|
|
5091
|
-
*
|
|
5091
|
+
* Sets the accessible label text of the link rendered inside the tile.
|
|
5092
5092
|
*/
|
|
5093
5093
|
label: string;
|
|
5094
5094
|
/**
|
|
5095
|
-
* Sets the `rel` attribute on the link.
|
|
5095
|
+
* Sets the `rel` attribute on the link (e.g. `noopener`).
|
|
5096
5096
|
*/
|
|
5097
5097
|
rel?: string;
|
|
5098
5098
|
/**
|
|
5099
|
-
*
|
|
5099
|
+
* Sets the font size of the description text in the tile content area. Supports responsive breakpoint values.
|
|
5100
5100
|
* @default 'medium'
|
|
5101
5101
|
*/
|
|
5102
5102
|
size?: BreakpointCustomizable<LinkTileSize>;
|
|
5103
5103
|
/**
|
|
5104
|
-
* Specifies where to open the linked
|
|
5104
|
+
* Specifies where to open the linked URL (e.g. `_self`, `_blank`).
|
|
5105
5105
|
* @default '_self'
|
|
5106
5106
|
*/
|
|
5107
5107
|
target?: LinkTileTarget;
|
|
5108
5108
|
/**
|
|
5109
|
-
*
|
|
5109
|
+
* Sets the font weight of the description text in the tile content area. Supports responsive breakpoint values.
|
|
5110
5110
|
* @default 'semi-bold'
|
|
5111
5111
|
*/
|
|
5112
5112
|
weight?: BreakpointCustomizable<LinkTileWeight>;
|
|
@@ -5131,46 +5131,46 @@ declare class PLinkTile extends BaseComponent {
|
|
|
5131
5131
|
|
|
5132
5132
|
type PLinkTileProductProps = {
|
|
5133
5133
|
/**
|
|
5134
|
-
*
|
|
5134
|
+
* Sets the width-to-height ratio of the tile media area. Supports responsive breakpoint values.
|
|
5135
5135
|
* @default '3/4'
|
|
5136
5136
|
*/
|
|
5137
5137
|
aspectRatio?: BreakpointCustomizable<LinkTileProductAspectRatio>;
|
|
5138
5138
|
/**
|
|
5139
|
-
*
|
|
5139
|
+
* Sets an optional short description providing additional product details below the price.
|
|
5140
5140
|
*/
|
|
5141
5141
|
description?: string;
|
|
5142
5142
|
/**
|
|
5143
|
-
*
|
|
5143
|
+
* Sets the product name displayed prominently at the top of the tile.
|
|
5144
5144
|
*/
|
|
5145
5145
|
heading: string;
|
|
5146
5146
|
/**
|
|
5147
|
-
*
|
|
5147
|
+
* Sets the URL the tile navigates to when clicked. Alternatively, provide a slotted anchor element.
|
|
5148
5148
|
*/
|
|
5149
5149
|
href?: string;
|
|
5150
5150
|
/**
|
|
5151
|
-
* Shows a like button.
|
|
5151
|
+
* Shows a like/bookmark button so users can save the product.
|
|
5152
5152
|
* @default true
|
|
5153
5153
|
*/
|
|
5154
5154
|
likeButton?: boolean;
|
|
5155
5155
|
/**
|
|
5156
|
-
*
|
|
5156
|
+
* Reflects whether the product is currently liked — controls the filled state of the like button.
|
|
5157
5157
|
* @default false
|
|
5158
5158
|
*/
|
|
5159
5159
|
liked?: boolean;
|
|
5160
5160
|
/**
|
|
5161
|
-
*
|
|
5161
|
+
* Sets the current retail price of the product, displayed with or without a discount.
|
|
5162
5162
|
*/
|
|
5163
5163
|
price: string;
|
|
5164
5164
|
/**
|
|
5165
|
-
*
|
|
5165
|
+
* Sets the original recommended retail price shown with a strikethrough to indicate a discount. Requires `price` to be set.
|
|
5166
5166
|
*/
|
|
5167
5167
|
priceOriginal?: string;
|
|
5168
5168
|
/**
|
|
5169
|
-
* Sets the `rel` attribute on the link.
|
|
5169
|
+
* Sets the `rel` attribute on the link (e.g. `noopener`).
|
|
5170
5170
|
*/
|
|
5171
5171
|
rel?: string;
|
|
5172
5172
|
/**
|
|
5173
|
-
* Specifies where to open the linked
|
|
5173
|
+
* Specifies where to open the linked URL (e.g. `_self`, `_blank`).
|
|
5174
5174
|
* @default '_self'
|
|
5175
5175
|
*/
|
|
5176
5176
|
target?: LinkTileProductTarget;
|
|
@@ -5193,36 +5193,36 @@ declare class PLinkTileProduct extends BaseComponent {
|
|
|
5193
5193
|
|
|
5194
5194
|
type PModalProps = {
|
|
5195
5195
|
/**
|
|
5196
|
-
* Sets ARIA attributes.
|
|
5196
|
+
* Sets ARIA attributes on the dialog element for improved accessibility when no visible heading is present.
|
|
5197
5197
|
*/
|
|
5198
5198
|
aria?: SelectedAriaAttributes<ModalAriaAttribute>;
|
|
5199
5199
|
/**
|
|
5200
|
-
*
|
|
5200
|
+
* Sets the backdrop style. Use `blur` when the modal is opened by user interaction; use `shading` when opened automatically (e.g. Cookie Consent).
|
|
5201
5201
|
* @default 'blur'
|
|
5202
5202
|
*/
|
|
5203
5203
|
backdrop?: ModalBackdrop;
|
|
5204
5204
|
/**
|
|
5205
|
-
*
|
|
5205
|
+
* Sets the background color of the modal panel (`canvas` or `surface`).
|
|
5206
5206
|
* @default 'canvas'
|
|
5207
5207
|
*/
|
|
5208
5208
|
background?: ModalBackground;
|
|
5209
5209
|
/**
|
|
5210
|
-
*
|
|
5210
|
+
* When enabled, clicking the backdrop will not close the modal.
|
|
5211
5211
|
* @default false
|
|
5212
5212
|
*/
|
|
5213
5213
|
disableBackdropClick?: boolean;
|
|
5214
5214
|
/**
|
|
5215
|
-
*
|
|
5215
|
+
* Shows a dismiss button in the modal header so the user can manually close it.
|
|
5216
5216
|
* @default true
|
|
5217
5217
|
*/
|
|
5218
5218
|
dismissButton?: boolean;
|
|
5219
5219
|
/**
|
|
5220
|
-
*
|
|
5220
|
+
* Expands the modal to the full viewport size, intended for mobile use cases. Supports responsive breakpoint values.
|
|
5221
5221
|
* @default false
|
|
5222
5222
|
*/
|
|
5223
5223
|
fullscreen?: BreakpointCustomizable<boolean>;
|
|
5224
5224
|
/**
|
|
5225
|
-
*
|
|
5225
|
+
* Controls whether the modal dialog is visible.
|
|
5226
5226
|
* @default false
|
|
5227
5227
|
*/
|
|
5228
5228
|
open: boolean;
|
|
@@ -5244,32 +5244,32 @@ declare class PModal extends BaseComponent {
|
|
|
5244
5244
|
|
|
5245
5245
|
type PModelSignatureProps = {
|
|
5246
5246
|
/**
|
|
5247
|
-
*
|
|
5247
|
+
* Sets the fill color of the signature using PDS color tokens.
|
|
5248
5248
|
* @default 'primary'
|
|
5249
5249
|
*/
|
|
5250
5250
|
color?: ModelSignatureColor;
|
|
5251
5251
|
/**
|
|
5252
|
-
* Sets the browser's fetch priority hint for the
|
|
5252
|
+
* Sets the browser's fetch priority hint for the signature asset (`auto`, `high`, `low`).
|
|
5253
5253
|
* @default 'auto'
|
|
5254
5254
|
*/
|
|
5255
5255
|
fetchPriority?: ModelSignatureFetchPriority;
|
|
5256
5256
|
/**
|
|
5257
|
-
*
|
|
5257
|
+
* Defers loading the signature until it enters the viewport to improve initial page performance.
|
|
5258
5258
|
* @default false
|
|
5259
5259
|
*/
|
|
5260
5260
|
lazy?: boolean;
|
|
5261
5261
|
/**
|
|
5262
|
-
*
|
|
5262
|
+
* Selects the Porsche model whose typographic signature SVG is displayed.
|
|
5263
5263
|
* @default '911'
|
|
5264
5264
|
*/
|
|
5265
5265
|
model?: ModelSignatureModel;
|
|
5266
5266
|
/**
|
|
5267
|
-
* When
|
|
5267
|
+
* When enabled, adds invisible padding so all model signatures visually align to a consistent baseline.
|
|
5268
5268
|
* @default true
|
|
5269
5269
|
*/
|
|
5270
5270
|
safeZone?: boolean;
|
|
5271
5271
|
/**
|
|
5272
|
-
*
|
|
5272
|
+
* Sets the display size of the signature using predefined PDS sizes. Use `inherit` with a CSS `width` or `height` on the host for custom sizing.
|
|
5273
5273
|
* @default 'small'
|
|
5274
5274
|
*/
|
|
5275
5275
|
size?: ModelSignatureSize;
|
|
@@ -5287,12 +5287,12 @@ declare class PModelSignature extends BaseComponent {
|
|
|
5287
5287
|
|
|
5288
5288
|
type PMultiSelectOptionProps = {
|
|
5289
5289
|
/**
|
|
5290
|
-
* Disables the option.
|
|
5290
|
+
* Disables the option, preventing it from being selected.
|
|
5291
5291
|
* @default false
|
|
5292
5292
|
*/
|
|
5293
5293
|
disabled?: boolean;
|
|
5294
5294
|
/**
|
|
5295
|
-
*
|
|
5295
|
+
* Sets the value submitted with the form data when this option is selected in the parent multi-select.
|
|
5296
5296
|
*/
|
|
5297
5297
|
value: string | number;
|
|
5298
5298
|
};
|
|
@@ -5305,12 +5305,12 @@ declare class PMultiSelectOption extends BaseComponent {
|
|
|
5305
5305
|
|
|
5306
5306
|
type POptgroupProps = {
|
|
5307
5307
|
/**
|
|
5308
|
-
* Disables the
|
|
5308
|
+
* Disables all options in the group, preventing any of them from being selected.
|
|
5309
5309
|
* @default false
|
|
5310
5310
|
*/
|
|
5311
5311
|
disabled?: boolean;
|
|
5312
5312
|
/**
|
|
5313
|
-
*
|
|
5313
|
+
* Sets the visible group heading displayed above the grouped options.
|
|
5314
5314
|
*/
|
|
5315
5315
|
label?: string;
|
|
5316
5316
|
};
|
|
@@ -5323,27 +5323,27 @@ declare class POptgroup extends BaseComponent {
|
|
|
5323
5323
|
|
|
5324
5324
|
type PPaginationProps = {
|
|
5325
5325
|
/**
|
|
5326
|
-
*
|
|
5326
|
+
* Sets the one-based index of the currently active page; update this prop to navigate programmatically.
|
|
5327
5327
|
* @default 1
|
|
5328
5328
|
*/
|
|
5329
5329
|
activePage: number;
|
|
5330
5330
|
/**
|
|
5331
|
-
*
|
|
5331
|
+
* Overrides the default ARIA label strings used for the previous, next, and page number buttons to support localisation.
|
|
5332
5332
|
* @default { root: 'Pagination', prev: 'Previous page', next: 'Next page', page: 'Page', }
|
|
5333
5333
|
*/
|
|
5334
5334
|
intl?: PaginationInternationalization;
|
|
5335
5335
|
/**
|
|
5336
|
-
*
|
|
5336
|
+
* Sets the number of items displayed per page, used together with `totalItemsCount` to compute the page count.
|
|
5337
5337
|
* @default 1
|
|
5338
5338
|
*/
|
|
5339
5339
|
itemsPerPage?: number;
|
|
5340
5340
|
/**
|
|
5341
|
-
*
|
|
5341
|
+
* Shows or hides the button that jumps directly to the last page of the pagination.
|
|
5342
5342
|
* @default true
|
|
5343
5343
|
*/
|
|
5344
5344
|
showLastPage?: boolean;
|
|
5345
5345
|
/**
|
|
5346
|
-
*
|
|
5346
|
+
* Sets the total number of items in the dataset, used to calculate the number of pages.
|
|
5347
5347
|
* @default 1
|
|
5348
5348
|
*/
|
|
5349
5349
|
totalItemsCount: number;
|
|
@@ -5361,15 +5361,15 @@ declare class PPagination extends BaseComponent {
|
|
|
5361
5361
|
|
|
5362
5362
|
type PPopoverProps = {
|
|
5363
5363
|
/**
|
|
5364
|
-
* Sets ARIA attributes.
|
|
5364
|
+
* Sets ARIA attributes on the popover panel to improve accessibility for screen readers.
|
|
5365
5365
|
*/
|
|
5366
5366
|
aria?: SelectedAriaAttributes<PopoverAriaAttribute>;
|
|
5367
5367
|
/**
|
|
5368
|
-
*
|
|
5368
|
+
* Sets the text content displayed inside the popover panel when it is open, providing contextual help or information.
|
|
5369
5369
|
*/
|
|
5370
5370
|
description?: string;
|
|
5371
5371
|
/**
|
|
5372
|
-
*
|
|
5372
|
+
* Sets the preferred direction for the popover to open relative to its trigger button. Falls back to the direction with the most available viewport space.
|
|
5373
5373
|
* @default 'bottom'
|
|
5374
5374
|
*/
|
|
5375
5375
|
direction?: PopoverDirection;
|
|
@@ -5384,21 +5384,21 @@ declare class PPopover extends BaseComponent {
|
|
|
5384
5384
|
|
|
5385
5385
|
type PRadioGroupOptionProps = {
|
|
5386
5386
|
/**
|
|
5387
|
-
*
|
|
5387
|
+
* Prevents this option from being selected and excludes its value from form submissions while it is disabled.
|
|
5388
5388
|
* @default false
|
|
5389
5389
|
*/
|
|
5390
5390
|
disabled?: boolean;
|
|
5391
5391
|
/**
|
|
5392
|
-
*
|
|
5392
|
+
* Sets the visible label text displayed next to the radio button that the user reads to identify the option.
|
|
5393
5393
|
*/
|
|
5394
5394
|
label?: string;
|
|
5395
5395
|
/**
|
|
5396
|
-
* @experimental
|
|
5396
|
+
* @experimental Disables this option and shows a spinner to indicate that this particular option is in a loading state.
|
|
5397
5397
|
* @default false
|
|
5398
5398
|
*/
|
|
5399
5399
|
loading?: boolean;
|
|
5400
5400
|
/**
|
|
5401
|
-
*
|
|
5401
|
+
* Sets the value submitted with the form data when this radio option is selected within its parent group.
|
|
5402
5402
|
*/
|
|
5403
5403
|
value?: string;
|
|
5404
5404
|
};
|
|
@@ -5418,11 +5418,11 @@ type PScrollerProps = {
|
|
|
5418
5418
|
*/
|
|
5419
5419
|
alignScrollIndicator?: ScrollerAlignScrollIndicator;
|
|
5420
5420
|
/**
|
|
5421
|
-
*
|
|
5421
|
+
* Sets the ARIA `role` attribute on the scroller's scroll container, useful for list-based navigation patterns.
|
|
5422
5422
|
*/
|
|
5423
5423
|
aria?: SelectedAriaAttributes<ScrollerAriaAttribute>;
|
|
5424
5424
|
/**
|
|
5425
|
-
*
|
|
5425
|
+
* Reduces the scroller's padding and the gap between slotted items for use in dense layouts.
|
|
5426
5426
|
*/
|
|
5427
5427
|
compact?: boolean;
|
|
5428
5428
|
/**
|
|
@@ -5430,7 +5430,7 @@ type PScrollerProps = {
|
|
|
5430
5430
|
*/
|
|
5431
5431
|
scrollToPosition?: ScrollerScrollToPosition;
|
|
5432
5432
|
/**
|
|
5433
|
-
*
|
|
5433
|
+
* Shows the browser's native scrollbar inside the scroller, in addition to the scroll indicator arrows.
|
|
5434
5434
|
* @default false
|
|
5435
5435
|
*/
|
|
5436
5436
|
scrollbar?: boolean;
|
|
@@ -5455,28 +5455,28 @@ declare class PScroller extends BaseComponent {
|
|
|
5455
5455
|
|
|
5456
5456
|
type PSegmentedControlItemProps = {
|
|
5457
5457
|
/**
|
|
5458
|
-
* Sets ARIA attributes.
|
|
5458
|
+
* Sets ARIA attributes on the item's button element to improve accessibility for screen readers.
|
|
5459
5459
|
*/
|
|
5460
5460
|
aria?: SelectedAriaAttributes<SegmentedControlItemAriaAttribute>;
|
|
5461
5461
|
/**
|
|
5462
|
-
*
|
|
5462
|
+
* Prevents this item from being selected and visually dims it; the parent's value will not change to this item's value.
|
|
5463
5463
|
* @default false
|
|
5464
5464
|
*/
|
|
5465
5465
|
disabled?: boolean;
|
|
5466
5466
|
/**
|
|
5467
|
-
*
|
|
5467
|
+
* Sets an icon rendered inside the item button using an icon name from the PDS icon library.
|
|
5468
5468
|
*/
|
|
5469
5469
|
icon?: SegmentedControlItemIcon;
|
|
5470
5470
|
/**
|
|
5471
|
-
*
|
|
5471
|
+
* Sets a URL to a custom SVG icon for the item button, overriding the built-in icon set.
|
|
5472
5472
|
*/
|
|
5473
5473
|
iconSource?: string;
|
|
5474
5474
|
/**
|
|
5475
|
-
*
|
|
5475
|
+
* Sets a visible text label rendered inside the item button, used when no slotted content is provided.
|
|
5476
5476
|
*/
|
|
5477
5477
|
label?: string;
|
|
5478
5478
|
/**
|
|
5479
|
-
*
|
|
5479
|
+
* Sets the value emitted by the parent `p-segmented-control` when this item is selected. This property is **required**.
|
|
5480
5480
|
*/
|
|
5481
5481
|
value: string | number;
|
|
5482
5482
|
};
|
|
@@ -5493,12 +5493,12 @@ declare class PSegmentedControlItem extends BaseComponent {
|
|
|
5493
5493
|
|
|
5494
5494
|
type PSelectOptionProps = {
|
|
5495
5495
|
/**
|
|
5496
|
-
*
|
|
5496
|
+
* Prevents the option from being selected and visually dims it to indicate it is unavailable.
|
|
5497
5497
|
* @default false
|
|
5498
5498
|
*/
|
|
5499
5499
|
disabled?: boolean;
|
|
5500
5500
|
/**
|
|
5501
|
-
*
|
|
5501
|
+
* Sets the value submitted with the form data when this option is selected in the parent select control.
|
|
5502
5502
|
*/
|
|
5503
5503
|
value?: string | number | null;
|
|
5504
5504
|
};
|
|
@@ -5511,26 +5511,26 @@ declare class PSelectOption extends BaseComponent {
|
|
|
5511
5511
|
|
|
5512
5512
|
type PSheetProps = {
|
|
5513
5513
|
/**
|
|
5514
|
-
* Sets ARIA attributes.
|
|
5514
|
+
* Sets ARIA attributes on the sheet dialog element for improved accessibility when the default `aria-label` is insufficient.
|
|
5515
5515
|
*/
|
|
5516
5516
|
aria?: SelectedAriaAttributes<SheetAriaAttribute>;
|
|
5517
5517
|
/**
|
|
5518
|
-
*
|
|
5518
|
+
* Sets the background color of the sheet panel (`canvas` or `surface`).
|
|
5519
5519
|
* @default 'canvas'
|
|
5520
5520
|
*/
|
|
5521
5521
|
background?: SheetBackground;
|
|
5522
5522
|
/**
|
|
5523
|
-
*
|
|
5523
|
+
* When enabled, clicking the backdrop will not close the sheet.
|
|
5524
5524
|
* @default false
|
|
5525
5525
|
*/
|
|
5526
5526
|
disableBackdropClick?: boolean;
|
|
5527
5527
|
/**
|
|
5528
|
-
*
|
|
5528
|
+
* Shows a dismiss button in the sheet header so users can manually close it.
|
|
5529
5529
|
* @default true
|
|
5530
5530
|
*/
|
|
5531
5531
|
dismissButton?: boolean;
|
|
5532
5532
|
/**
|
|
5533
|
-
*
|
|
5533
|
+
* Controls whether the sheet panel slides in from the bottom and is visible to the user.
|
|
5534
5534
|
* @default false
|
|
5535
5535
|
*/
|
|
5536
5536
|
open: boolean;
|
|
@@ -5550,16 +5550,16 @@ declare class PSheet extends BaseComponent {
|
|
|
5550
5550
|
|
|
5551
5551
|
type PSpinnerProps = {
|
|
5552
5552
|
/**
|
|
5553
|
-
* Sets ARIA attributes.
|
|
5553
|
+
* Sets ARIA attributes on the spinner's live region element; use `aria-label` to provide a descriptive loading message for screen readers.
|
|
5554
5554
|
*/
|
|
5555
5555
|
aria?: SelectedAriaAttributes<SpinnerAriaAttribute>;
|
|
5556
5556
|
/**
|
|
5557
|
-
*
|
|
5557
|
+
* Sets the color of the spinning indicator using PDS semantic color tokens (e.g. `primary`, `contrast-high`, `inherit`).
|
|
5558
5558
|
* @default 'primary'
|
|
5559
5559
|
*/
|
|
5560
5560
|
color?: SpinnerColor;
|
|
5561
5561
|
/**
|
|
5562
|
-
*
|
|
5562
|
+
* Sets the size of the spinner using the PDS typographic scale. Use `inherit` to derive the size from the parent element's font-size. Supports responsive breakpoint values.
|
|
5563
5563
|
* @default 'sm'
|
|
5564
5564
|
*/
|
|
5565
5565
|
size?: BreakpointCustomizable<SpinnerSize>;
|
|
@@ -5589,7 +5589,7 @@ type PStepperHorizontalItemProps = {
|
|
|
5589
5589
|
*/
|
|
5590
5590
|
disabled?: boolean;
|
|
5591
5591
|
/**
|
|
5592
|
-
* The
|
|
5592
|
+
* The current progression state of the step. Use `current` for the active step, `complete` for finished steps, `warning` for steps with issues. Leave unset for future steps.
|
|
5593
5593
|
*/
|
|
5594
5594
|
state?: StepperHorizontalItemState;
|
|
5595
5595
|
};
|
|
@@ -5602,37 +5602,37 @@ declare class PStepperHorizontalItem extends BaseComponent {
|
|
|
5602
5602
|
|
|
5603
5603
|
type PSwitchProps = {
|
|
5604
5604
|
/**
|
|
5605
|
-
*
|
|
5605
|
+
* Sets the position of the slotted label relative to the switch toggle, either before (`start`) or after (`end`) it. Supports responsive breakpoint values.
|
|
5606
5606
|
* @default 'end'
|
|
5607
5607
|
*/
|
|
5608
5608
|
alignLabel?: BreakpointCustomizable<SwitchAlignLabel>;
|
|
5609
5609
|
/**
|
|
5610
|
-
*
|
|
5610
|
+
* Reflects the switch's current on/off state and allows setting the initial checked value when the component first renders.
|
|
5611
5611
|
* @default false
|
|
5612
5612
|
*/
|
|
5613
5613
|
checked?: boolean;
|
|
5614
5614
|
/**
|
|
5615
|
-
*
|
|
5615
|
+
* Reduces the switch size and spacing for use in dense layouts where vertical space is limited.
|
|
5616
5616
|
* @default false
|
|
5617
5617
|
*/
|
|
5618
5618
|
compact?: boolean;
|
|
5619
5619
|
/**
|
|
5620
|
-
*
|
|
5620
|
+
* Prevents user interaction with the switch and blocks all click and keyboard events while it is disabled.
|
|
5621
5621
|
* @default false
|
|
5622
5622
|
*/
|
|
5623
5623
|
disabled?: boolean;
|
|
5624
5624
|
/**
|
|
5625
|
-
*
|
|
5625
|
+
* Hides the visible label while keeping it accessible to screen readers. Supports responsive breakpoint values.
|
|
5626
5626
|
* @default false
|
|
5627
5627
|
*/
|
|
5628
5628
|
hideLabel?: BreakpointCustomizable<boolean>;
|
|
5629
5629
|
/**
|
|
5630
|
-
* Disables the switch and shows a loading
|
|
5630
|
+
* Disables the switch and shows a loading spinner to indicate an ongoing asynchronous toggle operation.
|
|
5631
5631
|
* @default false
|
|
5632
5632
|
*/
|
|
5633
5633
|
loading?: boolean;
|
|
5634
5634
|
/**
|
|
5635
|
-
*
|
|
5635
|
+
* Expands the space between the switch toggle and its label to fill the full available width of the container. Supports responsive breakpoint values.
|
|
5636
5636
|
* @default false
|
|
5637
5637
|
*/
|
|
5638
5638
|
stretch?: BreakpointCustomizable<boolean>;
|
|
@@ -5652,21 +5652,21 @@ declare class PSwitch extends BaseComponent {
|
|
|
5652
5652
|
|
|
5653
5653
|
type PTableProps = {
|
|
5654
5654
|
/**
|
|
5655
|
-
*
|
|
5655
|
+
* Sets a screen-reader-only accessible caption that describes the table's content; it is not visible in the browser. Use an element with `slot="caption"` for a visible caption instead.
|
|
5656
5656
|
*/
|
|
5657
5657
|
caption?: string;
|
|
5658
5658
|
/**
|
|
5659
|
-
*
|
|
5659
|
+
* Reduces the cell padding and spacing for a more condensed table layout in data-dense UIs.
|
|
5660
5660
|
* @default false
|
|
5661
5661
|
*/
|
|
5662
5662
|
compact?: boolean;
|
|
5663
5663
|
/**
|
|
5664
|
-
* Controls the layout
|
|
5664
|
+
* Controls the CSS `table-layout` algorithm: `auto` sizes columns to fit their content, `fixed` distributes width equally.
|
|
5665
5665
|
* @default 'auto'
|
|
5666
5666
|
*/
|
|
5667
5667
|
layout?: TableLayout;
|
|
5668
5668
|
/**
|
|
5669
|
-
* @experimental Makes the scroll indicator sticky at the
|
|
5669
|
+
* @experimental Makes the scroll position indicator sticky at the viewport edge while scrolling, indicating overflow in the table.
|
|
5670
5670
|
* @default false
|
|
5671
5671
|
*/
|
|
5672
5672
|
sticky?: boolean;
|
|
@@ -5702,17 +5702,17 @@ declare class PTableHead extends BaseComponent {
|
|
|
5702
5702
|
|
|
5703
5703
|
type PTableHeadCellProps = {
|
|
5704
5704
|
/**
|
|
5705
|
-
* Hides the label
|
|
5705
|
+
* Hides the visible column label while keeping it accessible to screen readers. Only applies when `sort` is not set.
|
|
5706
5706
|
* @default false
|
|
5707
5707
|
*/
|
|
5708
5708
|
hideLabel?: boolean;
|
|
5709
5709
|
/**
|
|
5710
|
-
* Allows
|
|
5710
|
+
* Allows the column header text to wrap onto multiple lines instead of being truncated to a single line.
|
|
5711
5711
|
* @default false
|
|
5712
5712
|
*/
|
|
5713
5713
|
multiline?: boolean;
|
|
5714
5714
|
/**
|
|
5715
|
-
*
|
|
5715
|
+
* Configures sorting behavior for this column by providing an `id`, `active` state, and current `direction` (`asc` or `desc`).
|
|
5716
5716
|
*/
|
|
5717
5717
|
sort?: TableHeadCellSort;
|
|
5718
5718
|
};
|
|
@@ -5738,21 +5738,21 @@ declare class PTableRow extends BaseComponent {
|
|
|
5738
5738
|
|
|
5739
5739
|
type PTabsProps = {
|
|
5740
5740
|
/**
|
|
5741
|
-
*
|
|
5741
|
+
* Sets the zero-based index of the currently active tab; update this prop to switch tabs programmatically.
|
|
5742
5742
|
* @default 0
|
|
5743
5743
|
*/
|
|
5744
5744
|
activeTabIndex?: number;
|
|
5745
5745
|
/**
|
|
5746
|
-
*
|
|
5746
|
+
* Sets the background color of the tabs bar. Use `frosted` only when placed on top of images, videos, or gradients.
|
|
5747
5747
|
* @default 'none'
|
|
5748
5748
|
*/
|
|
5749
5749
|
background?: TabsBackground;
|
|
5750
5750
|
/**
|
|
5751
|
-
*
|
|
5751
|
+
* Reduces the tab height and padding for use in dense layouts where vertical space is limited.
|
|
5752
5752
|
*/
|
|
5753
5753
|
compact?: boolean;
|
|
5754
5754
|
/**
|
|
5755
|
-
*
|
|
5755
|
+
* Sets the font size of the tab labels using the PDS typographic scale. Supports responsive breakpoint values.
|
|
5756
5756
|
* @default 'small'
|
|
5757
5757
|
*/
|
|
5758
5758
|
size?: BreakpointCustomizable<TabsSize>;
|
|
@@ -5776,20 +5776,20 @@ declare class PTabs extends BaseComponent {
|
|
|
5776
5776
|
|
|
5777
5777
|
type PTabsBarProps = {
|
|
5778
5778
|
/**
|
|
5779
|
-
*
|
|
5779
|
+
* Sets the zero-based index of the currently active tab. Pass `undefined` to render all tabs in an unselected state.
|
|
5780
5780
|
*/
|
|
5781
5781
|
activeTabIndex?: number | undefined;
|
|
5782
5782
|
/**
|
|
5783
|
-
*
|
|
5783
|
+
* Sets the background color of the tabs bar. Use `frosted` only when placed on top of images, videos, or gradients.
|
|
5784
5784
|
* @default 'none'
|
|
5785
5785
|
*/
|
|
5786
5786
|
background?: TabsBarBackground;
|
|
5787
5787
|
/**
|
|
5788
|
-
*
|
|
5788
|
+
* Reduces the tab height and padding for use in dense layouts where vertical space is limited.
|
|
5789
5789
|
*/
|
|
5790
5790
|
compact?: boolean;
|
|
5791
5791
|
/**
|
|
5792
|
-
*
|
|
5792
|
+
* Sets the font size of the tab labels using the PDS typographic scale. Supports responsive breakpoint values.
|
|
5793
5793
|
* @default 'small'
|
|
5794
5794
|
*/
|
|
5795
5795
|
size?: BreakpointCustomizable<TabsBarSize>;
|
|
@@ -5813,7 +5813,7 @@ declare class PTabsBar extends BaseComponent {
|
|
|
5813
5813
|
|
|
5814
5814
|
type PTabsItemProps = {
|
|
5815
5815
|
/**
|
|
5816
|
-
*
|
|
5816
|
+
* Sets the label text displayed in the tab navigation button that the user clicks to activate this tab's content.
|
|
5817
5817
|
*/
|
|
5818
5818
|
label: string;
|
|
5819
5819
|
};
|
|
@@ -5825,21 +5825,21 @@ declare class PTabsItem extends BaseComponent {
|
|
|
5825
5825
|
|
|
5826
5826
|
type PTagProps = {
|
|
5827
5827
|
/**
|
|
5828
|
-
*
|
|
5828
|
+
* Reduces the tag's padding and height for use in dense layouts where vertical space is limited.
|
|
5829
5829
|
* @default false
|
|
5830
5830
|
*/
|
|
5831
5831
|
compact?: boolean;
|
|
5832
5832
|
/**
|
|
5833
|
-
*
|
|
5833
|
+
* Sets the icon displayed inside the tag alongside the label. Use `none` to render the tag without an icon.
|
|
5834
5834
|
* @default 'none'
|
|
5835
5835
|
*/
|
|
5836
5836
|
icon?: TagIcon;
|
|
5837
5837
|
/**
|
|
5838
|
-
*
|
|
5838
|
+
* Sets a URL to a custom SVG icon, overriding the built-in icon set when a brand-specific icon is needed.
|
|
5839
5839
|
*/
|
|
5840
5840
|
iconSource?: string;
|
|
5841
5841
|
/**
|
|
5842
|
-
*
|
|
5842
|
+
* Sets the visual style of the tag, which controls its background and text colors (e.g. `primary`, `secondary`, `notification-info`).
|
|
5843
5843
|
* @default 'secondary'
|
|
5844
5844
|
*/
|
|
5845
5845
|
variant?: TagVariant;
|
|
@@ -5855,16 +5855,16 @@ declare class PTag extends BaseComponent {
|
|
|
5855
5855
|
|
|
5856
5856
|
type PTagDismissibleProps = {
|
|
5857
5857
|
/**
|
|
5858
|
-
* Sets ARIA attributes.
|
|
5858
|
+
* Sets ARIA attributes on the dismiss button element, for example use `aria-label` to provide a descriptive close action for screen readers.
|
|
5859
5859
|
*/
|
|
5860
5860
|
aria?: SelectedAriaAttributes<TagDismissibleAriaAttribute>;
|
|
5861
5861
|
/**
|
|
5862
|
-
*
|
|
5862
|
+
* Reduces the tag's padding and height for use in dense layouts where vertical space is limited.
|
|
5863
5863
|
* @default false
|
|
5864
5864
|
*/
|
|
5865
5865
|
compact?: boolean;
|
|
5866
5866
|
/**
|
|
5867
|
-
*
|
|
5867
|
+
* Sets the visible label text displayed inside the tag alongside the dismiss button.
|
|
5868
5868
|
*/
|
|
5869
5869
|
label?: string;
|
|
5870
5870
|
};
|
|
@@ -5927,7 +5927,7 @@ declare class PText extends BaseComponent {
|
|
|
5927
5927
|
|
|
5928
5928
|
type PTextListProps = {
|
|
5929
5929
|
/**
|
|
5930
|
-
*
|
|
5930
|
+
* Sets the list type to either `unordered` (bulleted) or `ordered` (numbered), controlling the rendered HTML element (`ul` vs `ol`).
|
|
5931
5931
|
* @default 'unordered'
|
|
5932
5932
|
*/
|
|
5933
5933
|
type?: TextListType;
|
|
@@ -5952,20 +5952,20 @@ declare class PToast extends BaseComponent {
|
|
|
5952
5952
|
|
|
5953
5953
|
type PWordmarkProps = {
|
|
5954
5954
|
/**
|
|
5955
|
-
* Sets ARIA attributes.
|
|
5955
|
+
* Sets ARIA attributes on the anchor element to improve accessibility when the wordmark is used as a link.
|
|
5956
5956
|
*/
|
|
5957
5957
|
aria?: SelectedAriaAttributes<WordmarkAriaAttribute>;
|
|
5958
5958
|
/**
|
|
5959
|
-
* When
|
|
5959
|
+
* When set, wraps the wordmark in an anchor element that navigates to the given URL on click.
|
|
5960
5960
|
*/
|
|
5961
5961
|
href?: string;
|
|
5962
5962
|
/**
|
|
5963
|
-
*
|
|
5963
|
+
* Sets the display size of the Porsche wordmark SVG using predefined PDS size tokens (`small`, `medium`, `large`, `inherit`).
|
|
5964
5964
|
* @default 'small'
|
|
5965
5965
|
*/
|
|
5966
5966
|
size?: WordmarkSize;
|
|
5967
5967
|
/**
|
|
5968
|
-
* Specifies where to open the linked
|
|
5968
|
+
* Specifies where to open the linked URL when `href` is set (e.g. `_self`, `_blank`).
|
|
5969
5969
|
* @default '_self'
|
|
5970
5970
|
*/
|
|
5971
5971
|
target?: WordmarkTarget;
|