Skip to content

Phone component: example text param #4195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wt-bb wants to merge 2 commits into
base: main
Choose a base branch
from
+28 −1
Draft

Phone component: example text param #4195

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f10a19
allow example text
wt-bb Feb 6, 2026
4fbe51a
adjustment
wt-bb Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion libs/components/phone-field/src/lib/modules/phone-field/phone-field.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,27 @@ export class SkyPhoneFieldComponent implements OnDestroy, OnInit {
return this.#_selectedCountry;
}

/**
* Whether phone number example format hints are shown in the input help text.
* @default true
*/
@Input()
public set allowExampleText(value: boolean | undefined) {
const newValue = value !== false;
if (this.#_allowExampleText !== newValue) {
this.#_allowExampleText = newValue;
if (!newValue && this.inputBoxHostSvc) {
this.inputBoxHostSvc.setHintText(undefined);
} else {
this.#populateInputBoxHelpText();
}
}
}

public get allowExampleText(): boolean {
return this.#_allowExampleText;
}

@ViewChild('inputTemplateRef', {
read: TemplateRef,
static: true,
Expand Down Expand Up @@ -302,6 +323,8 @@ export class SkyPhoneFieldComponent implements OnDestroy, OnInit {

#_selectedCountry: SkyPhoneFieldCountry | undefined;

#_allowExampleText = true;

#countrySearchFormControl = new FormControl<
SkyCountryFieldCountry | undefined | null
>(undefined);
Expand Down Expand Up @@ -588,7 +611,11 @@ export class SkyPhoneFieldComponent implements OnDestroy, OnInit {
}

#populateInputBoxHelpText(): void {
if (this.inputBoxHostSvc && this.inputTemplateRef) {
if (
this.inputBoxHostSvc &&
this.inputTemplateRef &&
this.#_allowExampleText
) {
this.inputBoxHostSvc?.setHintText(
this.#appFormat.formatText(
this.#phoneNumberFormatHintTextTemplateString,
Expand Down
Loading