diff --git a/api-goldens/element-ng/form/index.api.md b/api-goldens/element-ng/form/index.api.md index 2cf6ff0312..c725fad86d 100644 --- a/api-goldens/element-ng/form/index.api.md +++ b/api-goldens/element-ng/form/index.api.md @@ -69,7 +69,6 @@ export class SiFormFieldsetComponent { // @public (undocumented) export class SiFormItemComponent implements AfterContentInit, AfterContentChecked, OnChanges, OnInit, OnDestroy, SiFormFieldsetControl { readonly disableErrorPrinting: _angular_core.InputSignalWithTransform; - // (undocumented) readonly formErrorMapper: _angular_core.InputSignal; readonly label: _angular_core.InputSignal; readonly labelWidth: _angular_core.InputSignal; @@ -168,7 +167,6 @@ export interface SiFormValidationErrorMapper { // @public export class SiFormValidationTooltipDirective implements DoCheck { constructor(); - // (undocumented) readonly formErrorMapper: _angular_core.InputSignal; } diff --git a/api-goldens/element-ng/formly/index.api.md b/api-goldens/element-ng/formly/index.api.md index f5354c6a8e..4a216fd50d 100644 --- a/api-goldens/element-ng/formly/index.api.md +++ b/api-goldens/element-ng/formly/index.api.md @@ -32,11 +32,9 @@ export class SiFormlyComponent[]>; - // (undocumented) readonly fieldsChange: _angular_core.OutputEmitterRef[]>; - // (undocumented) readonly form: _angular_core.ModelSignal | undefined>; readonly formlyForm: _angular_core.Signal; readonly labelWidth: _angular_core.InputSignal; diff --git a/api-goldens/element-ng/icon/index.api.md b/api-goldens/element-ng/icon/index.api.md index f8ba09383b..3be90e8055 100644 --- a/api-goldens/element-ng/icon/index.api.md +++ b/api-goldens/element-ng/icon/index.api.md @@ -47,7 +47,6 @@ export class SiIconModule { // @public (undocumented) export class SiStatusIconComponent { - // (undocumented) readonly status: _angular_core.InputSignal; } diff --git a/projects/element-ng/form/si-form-item/si-form-item.component.ts b/projects/element-ng/form/si-form-item/si-form-item.component.ts index 60122406d7..6e2a84c253 100644 --- a/projects/element-ng/form/si-form-item/si-form-item.component.ts +++ b/projects/element-ng/form/si-form-item/si-form-item.component.ts @@ -90,6 +90,7 @@ export class SiFormItemComponent */ readonly disableErrorPrinting = input(false, { transform: booleanAttribute }); + /** Maps validation errors of the contained control to custom messages. */ readonly formErrorMapper = input(); /** diff --git a/projects/element-ng/form/si-form-validation-tooltip/si-form-validation-tooltip.directive.ts b/projects/element-ng/form/si-form-validation-tooltip/si-form-validation-tooltip.directive.ts index ec701a9e8b..a14a5331bd 100644 --- a/projects/element-ng/form/si-form-validation-tooltip/si-form-validation-tooltip.directive.ts +++ b/projects/element-ng/form/si-form-validation-tooltip/si-form-validation-tooltip.directive.ts @@ -49,6 +49,7 @@ export class SiFormValidationTooltipDirective implements DoCheck { private tooltipService = inject(SiTooltipService); private formValidationService = inject(SiFormValidationErrorService); private formContainer = inject(SiFormContainerComponent, { optional: true }); + /** Maps validation errors of the associated form control to custom tooltip messages. */ readonly formErrorMapper = input(); private ngControl = inject(NgControl); private elementRef = inject(ElementRef); diff --git a/projects/element-ng/formly/si-formly.component.ts b/projects/element-ng/formly/si-formly.component.ts index a927e02731..55deaf15b5 100644 --- a/projects/element-ng/formly/si-formly.component.ts +++ b/projects/element-ng/formly/si-formly.component.ts @@ -47,6 +47,7 @@ export class SiFormlyComponent< */ readonly formlyForm = viewChild(FormlyForm); + /** Reactive form used by Formly. A form is created when none is provided. */ readonly form = model>(); /** * Mapping of field name and its value. @@ -80,9 +81,10 @@ export class SiFormlyComponent< // eslint-disable-next-line @angular-eslint/prefer-signal-model readonly fields = input([]); + /** Emits the effective field configuration, including configuration generated from `schema`. */ readonly fieldsChange = output(); - /** Define width for field labels in pixel */ + /** Width in pixels applied to field labels. */ readonly labelWidth = input(); protected readonly fieldConfig = computed(() => { diff --git a/projects/element-ng/formly/wrapper/si-formly-form-field-provider.directive.ts b/projects/element-ng/formly/wrapper/si-formly-form-field-provider.directive.ts index bf85ca7d11..51262f18c3 100644 --- a/projects/element-ng/formly/wrapper/si-formly-form-field-provider.directive.ts +++ b/projects/element-ng/formly/wrapper/si-formly-form-field-provider.directive.ts @@ -11,6 +11,7 @@ import { SI_FORM_ITEM_CONTROL, SiFormItemControl } from '@siemens/element-ng/for providers: [{ provide: SI_FORM_ITEM_CONTROL, useExisting: SiFormlyFormFieldProviderDirective }] }) export class SiFormlyFormFieldProviderDirective implements SiFormItemControl, OnChanges { + /** Formly field configuration used to provide form-item control metadata. */ readonly field = input.required(); readonly id = computed(() => this.field().id); diff --git a/projects/element-ng/header-dropdown/si-header-dropdown-items-factory.component.ts b/projects/element-ng/header-dropdown/si-header-dropdown-items-factory.component.ts index 49b796a2f2..979a1944ed 100644 --- a/projects/element-ng/header-dropdown/si-header-dropdown-items-factory.component.ts +++ b/projects/element-ng/header-dropdown/si-header-dropdown-items-factory.component.ts @@ -30,6 +30,8 @@ import { SiHeaderDropdownComponent } from './si-header-dropdown.component'; changeDetection: ChangeDetectionStrategy.Eager }) export class SiHeaderDropdownItemsFactoryComponent { + /** Menu items rendered by this factory. */ readonly items = input.required(); + /** Emits whether a generated dropdown item is active. */ readonly activeChange = output(); } diff --git a/projects/element-ng/header-dropdown/si-header-dropdown-trigger.directive.ts b/projects/element-ng/header-dropdown/si-header-dropdown-trigger.directive.ts index 29e46302c8..38b7c86123 100644 --- a/projects/element-ng/header-dropdown/si-header-dropdown-trigger.directive.ts +++ b/projects/element-ng/header-dropdown/si-header-dropdown-trigger.directive.ts @@ -60,9 +60,9 @@ class SiHeaderAnchorComponent { export class SiHeaderDropdownTriggerDirective implements OnChanges, OnInit, OnDestroy { private static idCounter = 0; - /** Template that be rendered inside the dropdown. */ + /** Template rendered inside the dropdown. */ readonly dropdown = input.required>({ alias: 'siHeaderDropdownTriggerFor' }); - /** Data that should be passed as template context to the dropdown. */ + /** Context data passed to the dropdown template. */ readonly dropdownData = input(); /** Emits whenever a dropdown is opened or closed. */ readonly openChange = output(); @@ -122,7 +122,7 @@ export class SiHeaderDropdownTriggerDirective implements OnChanges, OnInit, OnDe }); } - /** Whether the dropdown is open. */ + /** Whether the dropdown is currently open. */ get isOpen(): boolean { return this._isOpen; } diff --git a/projects/element-ng/icon/si-status-icon.component.ts b/projects/element-ng/icon/si-status-icon.component.ts index 0560de8a7d..8ac485c4b5 100644 --- a/projects/element-ng/icon/si-status-icon.component.ts +++ b/projects/element-ng/icon/si-status-icon.component.ts @@ -25,6 +25,7 @@ import { STATUS_ICON_CONFIG } from './status-icon'; export class SiStatusIconComponent { private readonly statusIcons = inject(STATUS_ICON_CONFIG); + /** Status that determines the rendered stacked icon and accessible label. */ readonly status = input.required(); protected readonly statusIcon = computed(() => this.statusIcons[this.status()]);