Porsche Design SystemSearchNavigate to GitHub repository of Porsche Design SystemOpen sidebar
ConfiguratorExamplesUsageAccessibilityAPI
Text Field Wrapper 🚫 Table of ContentsPropertiestype BreakpointCustomizable<T> = { base: T; xs?: T; s?: T; m?: T; l?: T; xl?: T; xxl?: T; };PropertyAttributeDescriptionTypeDefaultactionIcon action-iconAction icon can be set to locate for input type="search" in order to display an action button.type TextFieldWrapperActionIcon =
undefined
'locate'
undefined
actionLoading action-loadingDisables the action button and shows a loading indicator. No events will be triggered while loading state is active.booleanfalsedescription descriptionThe description text.string''hideLabel 🛠hide-labelShow or hide label and description text. For better accessibility it is recommended to show the label.boolean
BreakpointCustomizable<boolean>
false
label labelThe label text.string''message messageThe message styled depending on validation state.string''showCharacterCount 🚫show-character-countdeprecated since v3.0.0, will be removed with next major release, use showCounter instead. Show or hide max character count.booleanundefinedshowCounter show-counterShow or hide max character count.booleantrueshowPasswordToggle 🧪show-password-toggleexperimental Show or hide password toggle for input type="password".booleantruestate stateThe validation state.type TextFieldWrapperState =
'none'
'error'
'success'
'none'
submitButton submit-buttonShow search button if wrapped inside a form.booleantruetheme themeAdapts the color depending on the theme.type Theme =
'light'
'dark'
'auto'
'light'
unit unitThe unit text.string''unitPosition unit-positionThe unit position.type TextFieldWrapperUnitPosition =
'prefix'
'suffix'
'prefix'
EventsEventDescriptionTypeaction Emitted when the action button is clicked.CustomEvent<void>SlotsSlotDescriptionisRequiredaltPropallowedTagNames<slot name="label"> Shows a label. Only [phrasing content](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_categories#Phrasing_content) is allowed.<slot name="description"> Shows a description. Only [phrasing content](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_categories#Phrasing_content) is allowed.<slot> Default slot for the input.<slot name="message"> Shows a state message. Only [phrasing content](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_categories#Phrasing_content) is allowed.
Global settingsThemeChanges the theme of the application and any Porsche Design System component. It's possible to choose between forced theme light and dark. It's also possible to use auto, which applies light or dark theme depending on the operating system settings automatically.LightDarkAuto (sync with operating system)DirectionThe dir global attribute in HTML changes the direction of text and other content within an element. It's most often used on the <html> tag to set the entire page's direction, which is crucial for supporting languages that are written from right to left (RTL), such as Arabic and Hebrew. For example, using <html dir="rtl"> makes the entire page display from right to left, adjusting the layout and text flow accordingly.LTR (left-to-right)RTL (right-to-left)Text ZoomTo ensure accessibility and comply with WCAG 2.2 AA standards, it is mandatory for web content to support text resizing up to at least 200% without loss of content or functionality. Using relative units like rem is a best practice for achieving this, as they allow the text to scale uniformly based on the user's browser settings.100%130%150%200%