diff --git a/api/@ohos.arkui.advanced.Chip.static.d.ets b/api/@ohos.arkui.advanced.Chip.static.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..cc23ac7cca25baea28e49d2c2b70def9c5dd20d6 --- /dev/null +++ b/api/@ohos.arkui.advanced.Chip.static.d.ets @@ -0,0 +1,627 @@ +/* +* Copyright (C) 2025 Huawei Device Co., Ltd. +* Licensed under the Apache License, Version 2.0 (the 'License'), +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an 'AS IS' BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ + +import { Builder } from './arkui/component/builder'; +import { ResourceStr, SizeOptions, ResourceColor, VoidCallback, Dimension, LengthMetrics } from './arkui/component/units'; +import { SymbolGlyphModifier } from './arkui/SymbolGlyphModifier'; +import { Direction } from './arkui/component/enums'; + +/** + * Enum for ChipSize + * + * @enum { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum ChipSize { + /** + * Normal type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + NORMAL = 'NORMAL', + + /** + * Small type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + SMALL = 'SMALL' +} + +/** + * Enum for AccessibilitySelectedType + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum AccessibilitySelectedType { + /** + * Default type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + CLICKED = 0, + + /** + * Checked type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + CHECKED = 1, + + /** + * Selected type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + SELECTED = 2 +} + +/** + * Defines the icon common option. + * + * @interface IconCommonOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface IconCommonOptions { + + /** + * Image resource. + * + * @type { ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + src: ResourceStr; + + /** + * Image size option. + * + * @type { ?SizeOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + size?: SizeOptions; + + /** + * Image filled color. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + fillColor?: ResourceColor; + + /** + * Image filled color when chip is activated. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + activatedFillColor?: ResourceColor; +} + +/** + * Defines the suffix icon option. + * + * @extends IconCommonOptions + * @interface SuffixIconOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface SuffixIconOptions extends IconCommonOptions { + + /** + * Called when the suffix icon is clicked. + * + * @type { ?VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + action?: VoidCallback; + + /** + * Set accessibility text for icon. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityText?: ResourceStr; + + /** + * Set accessibility description for icon. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityDescription?: ResourceStr; + + /** + * Set accessibility level for icon. + * + * @type { ?string } + * @default 'auto' + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityLevel?: string; +} + +/** + * Defines the prefix icon option. + * + * @extends IconCommonOptions + * @interface PrefixIconOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface PrefixIconOptions extends IconCommonOptions {} + +/** + * Defines accessibility icon options. + * + * @interface AccessibilityOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface AccessibilityOptions { + /** + * Set accessibility level for accessibility icon. + * + * @type { ?string } + * @default 'auto' + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityLevel?: string; + + /** + * Set accessibility text for accessibility icon. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityText?: ResourceStr; + + /** + * Set accessibility description for accessibility icon. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityDescription?: ResourceStr; +} + +/** + * Defines accessibility options of default close icon. + * + * @extends AccessibilityOptions + * @interface CloseOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface CloseOptions extends AccessibilityOptions {} + +/** + * Defines chip symbolglyph options. + * + * @interface ChipSymbolGlyphOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ChipSymbolGlyphOptions { + + /** + * Symbol normal. + * + * @type { ?SymbolGlyphModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + normal?: SymbolGlyphModifier; + + /** + * Symbol activated. + * + * @type { ?SymbolGlyphModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + activated?: SymbolGlyphModifier; +} + +/** + * Defines accessibility options of suffix symbol. + * + * @interface ChipSuffixSymbolGlyphOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ChipSuffixSymbolGlyphOptions { + /** + * Set normal accessibility options for suffix symbol. + * + * @type { ?AccessibilityOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + normalAccessibility?: AccessibilityOptions; + + /** + * Set activated accessibility options for suffix symbol. + * + * @type { ?AccessibilityOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + activatedAccessibility?: AccessibilityOptions; + + /** + * Called when the suffix symbol is clicked. + * + * @type { ?VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + action?: VoidCallback; +} + +/** + * Defines label margin. + * + * @interface LabelMarginOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface LabelMarginOptions { + + /** + * Left label margin length. + * + * @type { ?Dimension } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + left?: Dimension; + + /** + * Right label margin length. + * + * @type { ?Dimension } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + right?: Dimension; +} + +/** + * Defines localized label margin. + * + * @interface LocalizedLabelMarginOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface LocalizedLabelMarginOptions { + + /** + * start localized label margin length. + * + * @type { ?LengthMetrics } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + start?: LengthMetrics; + + /** + * end localized label margin length. + * + * @type { ?LengthMetrics } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + end?: LengthMetrics; +} + +/** + * Defines label option. + * + * @interface LabelOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface LabelOptions { + + /** + * Text content. + * + * @type { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + text: string; + + /** + * Text font size. + * + * @type { ?Dimension } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + fontSize?: Dimension; + + /** + * Text font color. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + fontColor?: ResourceColor; + + /** + * Text font color when chip is activated. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + activatedFontColor?: ResourceColor; + + /** + * Text font family. + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + fontFamily?: string; + + /** + * Label margin. + * + * @type { ?LabelMarginOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + labelMargin?: LabelMarginOptions; + + /** + * Localized label margin. + * + * @type { ?LocalizedLabelMarginOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + localizedLabelMargin?: LocalizedLabelMarginOptions; +} + +/** + * Defines chip options. + * + * @interface ChipOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface ChipOptions { + /** + * Chip prefix icon. + * + * @type { ?PrefixIconOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + prefixIcon?: PrefixIconOptions; + + /** + * Chip prefix symbol. + * + * @type { ?ChipSymbolGlyphOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + prefixSymbol?: ChipSymbolGlyphOptions; + + /** + * Chip label. + * + * @type { LabelOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + label: LabelOptions; + + /** + * Chip suffix icon. + * + * @type { ?SuffixIconOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + suffixIcon?: SuffixIconOptions; + + /** + * Chip suffix symbol. + * + * @type { ?ChipSymbolGlyphOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + suffixSymbol?: ChipSymbolGlyphOptions; + + /** + * Set options for suffix symbol. + * + * @type { ?ChipSuffixSymbolGlyphOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + suffixSymbolOptions?: ChipSuffixSymbolGlyphOptions; + + /** + * Show close icon. + * + * @type { ?boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + allowClose?: boolean; + + /** + * Set options for default close icon when 'allowaClose' is true. + * + * @type { ?CloseOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + closeOptions?: CloseOptions; + + /** + * Enable chip. + * + * @type { ?boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + enabled?: boolean; + + /** + * Set whether chip is active or not. + * + * @type { ?boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + activated?: boolean; + + /** + * Chip background color. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + backgroundColor?: ResourceColor; + + /** + * Chip background color when chip is activated. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + activatedBackgroundColor?: ResourceColor; + + /** + * Chip radius. + * + * @type { ?Dimension } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + borderRadius?: Dimension; + + /** + * Chip size. + * + * @type { ?(ChipSize | SizeOptions) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + size?: ChipSize | SizeOptions; + + /** + * On close action. + * + * @type { ?VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + onClose?: VoidCallback; + + /** + * On clicked action. + * + * @type { ?VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + onClicked?: VoidCallback; + + /** + * Indicates the attribute of the current chip direction. + * + * @type { ?Direction } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + direction?: Direction; + + /** + * Set accessibility description for Chip. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityDescription?: ResourceStr; + + /** + * Set accessibility level for Chip. + * + * @type { ?string } + * @default 'auto' + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityLevel?: string; + + /** + * Set accessibility selected type for Chip. + * + * @type { ?AccessibilitySelectedType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilitySelectedType?: AccessibilitySelectedType; +} + +/** + * Build function of Chip. + * + * @param { ChipOptions } options - chip option. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +@Builder +export declare function Chip(options: ChipOptions): void; \ No newline at end of file