@alauda/ui 8.0.1-beta.2 → 8.0.1-beta.21

package/form/common-form.d.ts

@@ -2,9 +2,13 @@ import { ChangeDetectorRef, EventEmitter } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
 import { ReplaySubject } from 'rxjs';
 import * as i0 from "@angular/core";
+/**
+ * form control 内部不保持 value 属性，当不使用 ngModel 时可以通过 [(value)] 实现双向绑定；
+ * 也可以分别传入 value 和 监听 valueChange 事件以实现阻断用户操作的功能。
+ */
 export declare class CommonFormControl<V, M = V> implements ControlValueAccessor {
     protected cdr: ChangeDetectorRef;
-    get disabled(): boolean | '';
+    get disabled(): boolean | "";
     set disabled(val: boolean | '');
     get readonly(): boolean;
     set readonly(val: boolean);

package/input/autosize.directive.d.ts

@@ -5,12 +5,15 @@ export interface AutoSizeValue {
     minRows: number;
     maxRows?: number;
 }
+/**
+ * Directive to automatically resize a textarea to fit its content.
+ */
 export declare class AutosizeDirective implements AfterViewInit, OnDestroy {
     private readonly elRef;
     private readonly ngControl;
     private _autoSize;
     private readonly destroy$$;
-    get autoSize(): AutoSizeValue | '';
+    get autoSize(): AutoSizeValue | "";
     set autoSize(value: AutoSizeValue | '');
     constructor(elRef: ElementRef<HTMLTextAreaElement>, ngControl: NgControl);
     resizeTextarea(): void;

package/internal/types/index.d.ts

@@ -4,6 +4,9 @@ export declare const ComponentSize: {
     readonly Medium: "medium";
     readonly Small: "small";
     readonly Mini: "mini";
+    /**
+     * represents default internally, @link https://github.com/angular/vscode-ng-language-service/issues/1147
+     */
     readonly Empty: "";
 };
 export type ComponentSize = ValueOf<typeof ComponentSize>;

package/message/message.config.d.ts

@@ -5,13 +5,33 @@ export declare enum MessageType {
     Warning = "warning",
     Info = "info"
 }
+/**
+ * messageOptions: contains Basic configuration
+ * Just for some containers like Message-Container
+ * Detailed document： http://confluence.alaudatech.com/pages/viewpage.action?pageId=23383163
+ */
 export declare class MessageConfig {
+    /**
+     * the message type
+     */
     type?: MessageType;
+    /**
+     * The id of this message, The same ID can only have one at the same time
+     */
     id?: number | string;
+    /**
+     * automatically shut down after a few seconds, if <= 0 ,non automatic closure
+     */
     duration?: number;
+    /**
+     * message content
+     */
     content?: string;
 }
 export interface MessageGlobalConfig {
+    /**
+     * max instance in one time
+     */
     maxStack: number;
     duration: number | {
         [key in MessageType]: number;

package/notification/notification.component.d.ts

@@ -22,6 +22,10 @@ export declare class NotificationComponent extends MessageComponent implements A
     onMouseLeave(): void;
     ngAfterViewInit(): void;
     setConfig(config: NotificationConfig): void;
+    /**
+     * Attach a TemplatePortal as content to this modal container.
+     * @param portal Portal to be attached as the modal content.
+     */
     private attachTemplatePortal;
     private attachComponentRef;
     private countDown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alauda/ui",
-  "version": "8.0.1-beta.2",
+  "version": "8.0.1-beta.21",
   "description": "Angular UI components by Alauda Frontend Team.",
   "repository": "git+https://github.com/alauda/alauda-ui.git",
   "author": "Alauda Frontend",
@@ -17,12 +17,7 @@
     "ui"
   ],
   "peerDependencies": {
-    "@angular/animations": ">=18.0.0",
-    "@angular/cdk": ">=18.0.0",
-    "@angular/common": ">=18.0.0",
-    "@angular/core": ">=18.0.0",
-    "@angular/forms": ">=18.0.0",
-    "@angular/platform-browser": ">=18.0.0",
+    "@angular/cdk": ">=19.0.0",
     "dayjs": "^1.0.0",
     "rxjs": "^7.0.0"
   },
@@ -38,8 +33,6 @@
     },
     ".": {
       "types": "./index.d.ts",
-      "esm2022": "./esm2022/alauda-ui.mjs",
-      "esm": "./esm2022/alauda-ui.mjs",
       "default": "./fesm2022/alauda-ui.mjs"
     }
   },

package/paginator/paginator-intl.d.ts

@@ -1,7 +1,16 @@
 import { Subject } from 'rxjs';
 import * as i0 from "@angular/core";
+/**
+ * To modify the labels and text displayed, create a new instance of MatPaginatorIntl and
+ * include it in a custom provider
+ */
 export declare class PaginatorIntl {
+    /**
+     * Stream that emits whenever the labels here are changed. Use this to notify
+     * components if the labels have changed after initialization.
+     */
     readonly changes: Subject<void>;
+    /** A label for the page size selector. */
     itemsPerPageLabel: string;
     jumperLabelPrefix: string;
     jumperLabelSuffix: string;

package/radio/base-radio.d.ts

@@ -24,5 +24,5 @@ export declare class BaseRadio implements OnInit, AfterViewInit, OnDestroy {
     onClick(): void;
     onBlur(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<BaseRadio, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<BaseRadio, never, never, { "disabled": { "alias": "disabled"; "required": false; }; "value": { "alias": "value"; "required": false; }; }, {}, never, never, false, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<BaseRadio, never, never, { "disabled": { "alias": "disabled"; "required": false; }; "value": { "alias": "value"; "required": false; }; }, {}, never, never, true, never>;
 }

package/select/base-select.d.ts

@@ -37,6 +37,9 @@ export declare abstract class BaseSelect<T, V = T> extends CommonFormControl<V>
     contentOptions: QueryList<OptionComponent<T>>;
     isTemplateRef: (label: any) => label is import("@angular/core").TemplateRef<unknown>;
     isMulti: boolean;
+    /**
+     * Utility field to make sure the users always see the value as type array
+     */
     abstract readonly values$: Observable<T[]>;
     allOptions$: Observable<Array<OptionComponent<T>>>;
     protected focusedOption: OptionComponent<T>;

package/select/validators.d.ts

@@ -8,7 +8,7 @@ export declare class AuiSelectValidators {
 }
 export declare class IncludesDirective<T> implements Validator, AfterContentInit {
     private readonly selectRef;
-    get includes(): boolean | '';
+    get includes(): boolean | "";
     set includes(val: boolean | '');
     trackFn: TrackFn<T>;
     private _includes;

package/sort/sort-errors.d.ts

@@ -1,4 +1,8 @@
+/** @docs-private */
 export declare function getSortDuplicateSortableIdError(id: string): Error;
+/** @docs-private */
 export declare function getSortHeaderNotContainedWithinSortError(): Error;
+/** @docs-private */
 export declare function getSortHeaderMissingIdError(): Error;
+/** @docs-private */
 export declare function getSortInvalidDirectionError(direction: string): Error;

package/table/table-cell-def.directive.d.ts

@@ -1,5 +1,9 @@
 import { CdkCellDef } from '@angular/cdk/table';
 import * as i0 from "@angular/core";
+/**
+ * Cell definition for the aui-table.
+ * Captures the template of a column's data row cell as well as cell-specific properties.
+ */
 export declare class TableCellDefDirective extends CdkCellDef {
     static ɵfac: i0.ɵɵFactoryDeclaration<TableCellDefDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<TableCellDefDirective, "[auiTableCellDef]", never, {}, {}, never, never, true, never>;

package/table/table-cell.directive.d.ts

@@ -1,6 +1,7 @@
 import { CdkCell, CdkColumnDef } from '@angular/cdk/table';
 import { ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
+/** Cell template container that adds the right classes and role. */
 export declare class TableCellDirective extends CdkCell {
     direction: 'column' | 'row';
     constructor(columnDef: CdkColumnDef, elementRef: ElementRef<HTMLElement>);

package/table/table-column-def.directive.d.ts

@@ -1,5 +1,9 @@
 import { CdkColumnDef } from '@angular/cdk/table';
 import * as i0 from "@angular/core";
+/**
+ * Column definition for the aui-table.
+ * Defines a set of cells available for a table column.
+ */
 export declare class TableColumnDefDirective extends CdkColumnDef {
     set auiTableColumnDef(value: string);
     static ɵfac: i0.ɵɵFactoryDeclaration<TableColumnDefDirective, never>;

package/table/table-header-cell-def.directive.d.ts

@@ -1,5 +1,9 @@
 import { CdkHeaderCellDef } from '@angular/cdk/table';
 import * as i0 from "@angular/core";
+/**
+ * Header cell definition for the aui-table.
+ * Captures the template of a column's header cell and as well as cell-specific properties.
+ */
 export declare class TableHeaderCellDefDirective extends CdkHeaderCellDef {
     static ɵfac: i0.ɵɵFactoryDeclaration<TableHeaderCellDefDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<TableHeaderCellDefDirective, "[auiTableHeaderCellDef]", never, {}, {}, never, never, true, never>;

package/table/table-header-cell.directive.d.ts

@@ -1,6 +1,7 @@
 import { CdkColumnDef, CdkHeaderCell } from '@angular/cdk/table';
 import { ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
+/** Header cell template container that adds the right classes and role. */
 export declare class TableHeaderCellDirective extends CdkHeaderCell {
     constructor(columnDef: CdkColumnDef, elementRef: ElementRef<HTMLElement>);
     static ɵfac: i0.ɵɵFactoryDeclaration<TableHeaderCellDirective, never>;

package/table/table-header-row-def.directive.d.ts

@@ -1,5 +1,9 @@
 import { CdkHeaderRowDef } from '@angular/cdk/table';
 import * as i0 from "@angular/core";
+/**
+ * Header row definition for the aui-table.
+ * Captures the header row's template and other header properties such as the columns to display.
+ */
 export declare class TableHeaderRowDefDirective extends CdkHeaderRowDef {
     columns: Iterable<string>;
     set auiTableHeaderRowDefSticky(val: boolean);

package/table/table-header-row.component.d.ts

@@ -1,5 +1,6 @@
 import { CdkHeaderRow } from '@angular/cdk/table';
 import * as i0 from "@angular/core";
+/** Header template container that contains the cell outlet. Adds the right class and role. */
 export declare class TableHeaderRowComponent extends CdkHeaderRow {
     static ɵfac: i0.ɵɵFactoryDeclaration<TableHeaderRowComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TableHeaderRowComponent, "aui-table-header-row", ["auiTableHeaderRow"], {}, {}, never, never, true, never>;

package/table/table-row-def.directive.d.ts

@@ -1,5 +1,10 @@
 import { CdkRowDef } from '@angular/cdk/table';
 import * as i0 from "@angular/core";
+/**
+ * Data row definition for the aui-table.
+ * Captures the header row's template and other row properties such as the columns to display and
+ * a when predicate that describes when this row should be used.
+ */
 export declare class TableRowDefDirective<T> extends CdkRowDef<T> {
     columns: Iterable<string>;
     set auiTableRowDefWhen(v: (index: number, rowData: T) => boolean);

package/table/table-row.component.d.ts

@@ -1,6 +1,7 @@
 import { CdkRow } from '@angular/cdk/table';
 import { AfterContentInit, ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
+/** Data row template container that contains the cell outlet. Adds the right class and role. */
 export declare class TableRowComponent extends CdkRow implements AfterContentInit {
     private readonly elRef;
     disabled: boolean;

package/table/table-scroll.directive.d.ts

@@ -14,7 +14,7 @@ export declare class TableScrollableDirective extends CdkScrollable implements A
     private readonly el;
     private readonly table;
     set scrollable(scrollable: boolean | '');
-    get scrollable(): boolean | '';
+    get scrollable(): boolean | "";
     private _scrollable;
     scrollable$$: BehaviorSubject<boolean>;
     destroy$$: Subject<void>;

package/tabs/tab-body.component.d.ts

@@ -5,34 +5,46 @@ import * as i0 from "@angular/core";
 export declare class TabBodyComponent implements OnDestroy {
     private _content;
     content$: BehaviorSubject<TemplatePortal<any>>;
+    /** The portal host inside of this container into which the tab body content will be loaded. */
     _portalOutlet: CdkPortalOutlet;
+    /** The tab body content to display. */
     get content(): TemplatePortal;
     set content(content: TemplatePortal);
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TabBodyComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TabBodyComponent, "aui-tab-body", never, { "content": { "alias": "content"; "required": false; }; }, {}, never, never, true, never>;
 }
+/** Used to flag tab labels for use with the portal directive */
 export declare class TabLabelDirective extends CdkPortal {
     constructor(templateRef: TemplateRef<any>, viewContainerRef: ViewContainerRef);
     static ɵfac: i0.ɵɵFactoryDeclaration<TabLabelDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<TabLabelDirective, "[auiTabLabel]", never, {}, {}, never, never, true, never>;
 }
+/**
+ * Lazy load the embedded template for a tab content.
+ */
 export declare class TabContentDirective {
     template: TemplateRef<any>;
     constructor(template: TemplateRef<any>);
     static ɵfac: i0.ɵɵFactoryDeclaration<TabContentDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<TabContentDirective, "[auiTabContent]", never, {}, {}, never, never, true, never>;
 }
+/** Used to project additional template from host to the tab header. */
 export declare class TabHeaderAddonDirective extends CdkPortal {
     constructor(templateRef: TemplateRef<any>, viewContainerRef: ViewContainerRef);
     static ɵfac: i0.ɵɵFactoryDeclaration<TabHeaderAddonDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<TabHeaderAddonDirective, "[auiTabHeaderAddon]", never, {}, {}, never, never, true, never>;
 }
+/**
+ * Used in the `aui-tab-group` view to display tab labels.
+ */
 export declare class TabLabelWrapperDirective {
     elementRef: ElementRef<HTMLElement>;
+    /** Whether or not the tab is disabled  */
     disabled: boolean;
     getOffsetLeft(): number;
     getOffsetWidth(): number;
+    /** Sets focus on the wrapper element */
     focus(): void;
     constructor(elementRef: ElementRef<HTMLElement>);
     static ɵfac: i0.ɵɵFactoryDeclaration<TabLabelWrapperDirective, never>;
@@ -44,10 +56,14 @@ export declare class TabTitleDirective extends CdkPortal {
     static ɵfac: i0.ɵɵFactoryDeclaration<TabTitleDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<TabTitleDirective, "[auiTabTitle]", never, {}, {}, never, never, true, never>;
 }
+/**
+ * The portal host directive for the contents of the tab.
+ */
 export declare class TabBodyPortalDirective extends CdkPortalOutlet implements OnInit, OnDestroy {
     private readonly _host;
     private _hostSubscription;
     constructor(componentFactoryResolver: ComponentFactoryResolver, viewContainerRef: ViewContainerRef, _host: TabBodyComponent);
+    /** Set initial visibility or set up subscription for changing visibility. */
     ngOnInit(): void;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TabBodyPortalDirective, never>;

package/tabs/tab-context.service.d.ts

@@ -3,6 +3,9 @@ import * as i0 from "@angular/core";
 export declare class TabContextService {
     readonly _parent: TabContextService;
     private readonly active$$;
+    /**
+     * Whether the tab is currently active.
+     */
     get isActive(): boolean;
     set isActive(isActive: boolean);
     readonly active$: Observable<boolean>;

package/tabs/tab-group.component.d.ts

@@ -6,8 +6,11 @@ import { TabHeaderComponent } from './tab-header.component';
 import { TabComponent } from './tab.component';
 import { TabSize, TabType } from './tabs.types';
 import * as i0 from "@angular/core";
+/** A simple change event emitted on focus or selection changes. */
 export declare class TabChangeEvent {
+    /** Index of the currently-selected tab. */
     index: number;
+    /** Reference to the currently-selected tab. */
     tab: TabComponent;
 }
 export declare class TabGroupComponent implements OnChanges, AfterContentChecked, AfterContentInit, OnDestroy {
@@ -17,17 +20,24 @@ export declare class TabGroupComponent implements OnChanges, AfterContentChecked
     _headerAddon: TabHeaderAddonDirective;
     _tabHeader: TabHeaderComponent;
     _tabTitle: TabTitleDirective;
+    /** The tab index that should be selected after the content has been checked. */
     private _indexToSelect;
+    /** Subscription to tabs being added/removed. */
     private _tabsSubscription;
+    /** Subscription to changes in the tab labels. */
     private _tabLabelSubscription;
     private _selectedIndex;
     private _tab;
     private _type;
     private _size;
+    /** true lazy mode for template ref children */
     private _lazy;
     private _previousHeaderAddon;
+    /** Emits whenever the type changes */
     readonly _typeChange: Subject<void>;
+    /** Emits whenever the size changes */
     readonly _sizeChange: Subject<void>;
+    /** The index of the active tab. */
     get selectedIndex(): number;
     set selectedIndex(value: number);
     get tab(): string;
@@ -39,25 +49,43 @@ export declare class TabGroupComponent implements OnChanges, AfterContentChecked
     set size(val: TabSize);
     get lazy(): boolean;
     set lazy(lazy: boolean);
+    /** Output to enable support for two-way binding on `[(selectedIndex)]` */
     readonly selectedIndexChange: EventEmitter<number>;
     readonly tabChange: EventEmitter<string>;
+    /** Event emitted when the tab selection has changed. */
     readonly selectedTabChange: EventEmitter<TabChangeEvent>;
+    /** Event emitted when focus has changed within a tab group. */
     readonly focusChange: EventEmitter<TabChangeEvent>;
     constructor(_changeDetectorRef: ChangeDetectorRef);
     activatedTabs: TabComponent[];
     get activeTab(): TabComponent;
     ngOnChanges(changes: SimpleChanges): void;
+    /**
+     * After the content is checked, this component knows what tabs have been defined
+     * and what the selected index should be. This is where we can know exactly what position
+     * each tab should be in according to the new selected index.
+     */
     ngAfterContentChecked(): void;
     ngAfterContentInit(): void;
     ngOnDestroy(): void;
+    /** Handle click events, setting new selected index if appropriate. */
     _handleClick(tab: TabComponent, idx: number): void;
     _focusChanged(index: number): void;
+    /** Re-aligns the ink bar to the selected tab element. */
     realignActiveIndicator(): void;
     private _changeActivatedTabs;
+    /** Clamps the given index to the bounds of 0 and the tabs length. */
     private _clampTabIndex;
     private _findIndexByTab;
     private _createChangeEvent;
+    /**
+     * Subscribes to changes in the tab labels. This is needed, because the @Input for the label is
+     * on the Tab component, whereas the data binding is inside the TabGroup. In order for the
+     * binding to be updated, we need to subscribe to changes in it and trigger change detection
+     * manually.
+     */
     private _subscribeToTabLabels;
+    /** Retrieves the tabindex for the tab. */
     _getTabIndex(tab: TabComponent, idx: number): number | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<TabGroupComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TabGroupComponent, "aui-tab-group", ["auiTabGroup"], { "selectedIndex": { "alias": "selectedIndex"; "required": false; }; "tab": { "alias": "tab"; "required": false; }; "type": { "alias": "type"; "required": false; }; "title": { "alias": "title"; "required": false; }; "size": { "alias": "size"; "required": false; }; "lazy": { "alias": "lazy"; "required": false; }; }, { "selectedIndexChange": "selectedIndexChange"; "tabChange": "tabChange"; "selectedTabChange": "selectedTabChange"; "focusChange": "focusChange"; }, ["_headerAddon", "_tabTitle", "_tabs"], never, true, never>;

package/tabs/tab-header-active-indicator.component.d.ts

@@ -8,7 +8,16 @@ export declare class TabHeaderActiveIndicatorComponent {
     type: TabType;
     bem: Bem;
     constructor(_elementRef: ElementRef<HTMLElement>, _ngZone: NgZone);
+    /**
+     * Calculates the styles from the provided element in order to align the indicator to that element.
+     * Shows the indicator if previously set as hidden.
+     * @param element
+     */
     alignToElement(element: HTMLElement): void;
+    /**
+     * Sets the proper styles to the element.
+     * @param element
+     */
     private _setStyles;
     private _getElementPosition;
     static ɵfac: i0.ɵɵFactoryDeclaration<TabHeaderActiveIndicatorComponent, never>;

package/tabs/tab-header.component.d.ts

@@ -4,28 +4,47 @@ import { TabHeaderAddonDirective, TabLabelWrapperDirective, TabTitleDirective }
 import { TabHeaderActiveIndicatorComponent } from './tab-header-active-indicator.component';
 import { TabSize, TabType } from './tabs.types';
 import * as i0 from "@angular/core";
+/**
+ * The directions that scrolling can go in when the header's tabs exceed the header width. 'After'
+ * will scroll the header towards the end of the tabs list and 'before' will scroll towards the
+ * beginning of the list.
+ */
 export type ScrollDirection = 'after' | 'before';
 export declare class TabHeaderComponent implements OnDestroy, AfterContentChecked, AfterContentInit {
     private readonly _changeDetectorRef;
     bem: Bem;
     _showAddon: boolean;
+    /** Whether the controls for pagination should be displayed */
     _showPaginationControls: boolean;
+    /** Whether the tab list can be scrolled more towards the end of the tab label list. */
     _disableScrollAfter: boolean;
+    /** Whether the tab list can be scrolled more towards the beginning of the tab label list. */
     _disableScrollBefore: boolean;
+    /** Whether the scroll distance has changed and should be applied after the view is checked. */
     private _scrollDistanceChanged;
+    /** Whether the header should scroll to the selected index after the view has been checked. */
     private _selectedIndexChanged;
+    /** The distance in pixels that the tab labels should be translated to the left. */
     private _scrollDistance;
     private _selectedIndex;
+    /** Emits when the component is destroyed. */
     private readonly _destroyed;
+    /** Used to manage focus between the tabs. */
     private _keyManager;
     type: TabType;
     size: TabSize;
+    /** The index of the active tab. */
     get selectedIndex(): number;
     set selectedIndex(value: number);
+    /** Event emitted when the option is selected. */
     readonly selectFocusedIndex: EventEmitter<number>;
+    /** Event emitted when a label is focused. */
     readonly indexFocused: EventEmitter<number>;
     _headerAddon: TabHeaderAddonDirective;
     _title: TabTitleDirective;
+    /**
+     * workaround for @link https://github.com/microsoft/TypeScript/pull/42425
+     */
     _labelWrappers: QueryList<TabLabelWrapperDirective & {
         disabled?: boolean;
     }>;
@@ -35,22 +54,82 @@ export declare class TabHeaderComponent implements OnDestroy, AfterContentChecke
     _activeIndicator: TabHeaderActiveIndicatorComponent;
     ngOnDestroy(): void;
     ngAfterContentChecked(): void;
+    /**
+     * Aligns the ink bar to the selected tab on load.
+     */
     ngAfterContentInit(): void;
+    /** Sets the distance in pixels that the tab header should be transformed in the X-axis. */
     get scrollDistance(): number;
     set scrollDistance(v: number);
+    /** Tracks which element has focus; used for keyboard navigation */
     get focusIndex(): number;
+    /** When the focus index is set, we must manually send focus to the correct label */
     set focusIndex(value: number);
+    /**
+     * Determines if an index is valid.  If the tabs are not ready yet, we assume that the user is
+     * providing a valid index and return true.
+     */
     _isValidIndex(index: number): boolean;
     _handleKeydown(event: KeyboardEvent): void;
+    /**
+     * Sets focus on the HTML element for the label wrapper and scrolls it into the view if
+     * scrolling is enabled.
+     */
     _setTabFocus(tabIndex: number): void;
+    /**
+     * Moves the tab list such that the desired tab label (marked by index) is moved into view.
+     *
+     * This is an expensive call that forces a layout reflow to compute box and scroll metrics and
+     * should be called sparingly.
+     */
     _scrollToLabel(labelIndex: number): void;
+    /**
+     * Moves the tab list in the 'before' or 'after' direction (towards the beginning of the list or
+     * the end of the list, respectively). The distance to scroll is computed to be a third of the
+     * length of the tab list view window.
+     *
+     * This is an expensive call that forces a layout reflow to compute box and scroll metrics and
+     * should be called sparingly.
+     */
     _scrollHeader(scrollDir: ScrollDirection): void;
+    /**
+     * Callback for when the MutationObserver detects that the content has changed.
+     */
     _onContentChanges(): void;
+    /**
+     * Updating the view whether pagination should be enabled or not
+     */
     _updatePagination(): void;
+    /**
+     * Evaluate whether the pagination controls should be displayed. If the scroll width of the
+     * tab list is wider than the size of the header container, then the pagination controls should
+     * be shown.
+     *
+     * This is an expensive call that forces a layout reflow to compute box and scroll metrics and
+     * should be called sparingly.
+     */
     _checkPaginationEnabled(): void;
+    /**
+     * Evaluate whether the before and after controls should be enabled or disabled.
+     * If the header is at the beginning of the list (scroll distance is equal to 0) then disable the
+     * before button. If the header is at the end of the list (scroll distance is equal to the
+     * maximum distance we can scroll), then disable the after button.
+     *
+     * This is an expensive call that forces a layout reflow to compute box and scroll metrics and
+     * should be called sparingly.
+     */
     _checkScrollingControls(): void;
+    /**
+     * Determines what is the maximum length in pixels that can be set for the scroll distance. This
+     * is equal to the difference in width between the tab list container and tab header container.
+     *
+     * This is an expensive call that forces a layout reflow to compute box and scroll metrics and
+     * should be called sparingly.
+     */
     _getMaxScrollDistance(): number;
+    /** Performs the CSS transformation on the tab list that will cause the list to scroll. */
     _updateTabScrollPosition(): void;
+    /** Tells the active indicator to align itself to the current label wrapper */
     _alignActiveIndicatorToSelectedTab(): void;
     constructor(_changeDetectorRef: ChangeDetectorRef);
     static ɵfac: i0.ɵɵFactoryDeclaration<TabHeaderComponent, never>;

package/tabs/tab.component.d.ts

@@ -8,17 +8,35 @@ export declare class TabComponent implements AfterContentInit, OnDestroy, OnChan
     private readonly _viewContainerRef;
     readonly tabContext: TabContextService;
     name: string;
+    /** Plain text label for the tab, used when there is no template label. */
     textLabel: string;
+    /** Whether or not to show the close button in the header */
     closeable: boolean;
+    /** Whether or not the tab is disabled  */
     disabled: boolean;
     close: EventEmitter<void>;
+    /** Content for the tab label given by `<ng-template [auiTabLabel]>`. */
     templateLabel: TabLabelDirective;
+    /**
+     * Template provided in the tab content that will be used if present, used to enable lazy-loading
+     */
     _explicitContent: TemplateRef<any>;
+    /** Template inside the AuiTab view that contains an `<ng-content>`. */
     _implicitContent: TemplateRef<any>;
     get content(): TemplatePortal | null;
+    /**
+     * The relatively indexed position where 0 represents the center, negative is left, and positive
+     * represents the right.
+     */
     position: number | null;
+    /**
+     * The initial relatively index origin of the tab if it was created and selected after there
+     * was already a selected tab. Provides context of what position the tab should originate from.
+     */
     origin: number | null;
+    /** Emits whenever the internal state of the tab changes. */
     readonly _stateChanges: Subject<void>;
+    /** Portal that will be the hosted content of the tab */
     private _contentPortal;
     constructor(_viewContainerRef: ViewContainerRef, tabContext: TabContextService);
     ngAfterContentInit(): void;

package/tabs/tabs.types.d.ts

@@ -1,7 +1,10 @@
 import { ValueOf } from '../internal/types';
 export declare const TabSize: {
+    /** 卡片级尺寸 */
     readonly Large: "large";
+    /** 页面级尺寸 */
     readonly Medium: "medium";
+    /** 小尺寸 */
     readonly Small: "small";
 };
 export type TabSize = ValueOf<typeof TabSize>;