/*
* Copyright (c) 2026 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
*/
import { ColorMetrics, LengthMetrics, SizeT } from './@ohos.arkui.node';
import { ImageModifier, SymbolGlyphModifier, TextModifier } from './@ohos.arkui.modifier';
import uiMaterial from './@ohos.arkui.uiMaterial';
/**
* Enum for ChipV2 Size
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export declare enum ChipV2Size {
/**
* Normal type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
NORMAL = 'NORMAL',
/**
* Small type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
SMALL = 'SMALL',
}
/**
* Enum for ChipV2AccessibilitySelectedType
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export declare enum ChipV2AccessibilitySelectedType {
/**
* Default type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
CLICKED = 0,
/**
* Checked type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
CHECKED = 1,
/**
* Selected type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
SELECTED = 2
}
/**
* Defines icon common config.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2ImageIconConfig {
/**
* Image resource.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
src: ResourceStr;
/**
* Image size option.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
size?: SizeT<LengthMetrics>;
/**
* Image filled color.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
fillColor?: ColorMetrics;
/**
* Image filled color when chip is activated.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
activatedFillColor?: ColorMetrics;
/**
* Modifier for the icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
modifier?: ImageModifier;
}
/**
* ChipV2 icon common option
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export abstract class ChipV2ImageIcon extends ChipV2Icon {
/**
* Image resource.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public src: ResourceStr;
/**
* Image size option.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public size?: SizeT<LengthMetrics>;
/**
* Image filled color.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public fillColor?: ColorMetrics;
/**
* Image filled color when chip is activated.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public activatedFillColor?: ColorMetrics;
/**
* Modifier for icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public modifier?: ImageModifier;
/**
* The constructor of ChipV2ImageIcon
*
* @param { ChipV2ImageIconConfig } config - config of icon common Mandatory parameter.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2ImageIconConfig);
}
/**
* Defines suffix icon option.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2SuffixImageIconConfig extends ChipV2ImageIconConfig, ChipV2AccessibilityConfig {
/**
* Called when suffix icon is clicked.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
action?: VoidCallback;
}
/**
* Defines suffix icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export declare class ChipV2SuffixImageIcon extends ChipV2ImageIcon {
/**
* Set accessibility level.
*
* @default auto
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilityLevel?: string;
/**
* Set accessibility text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilityText?: ResourceStr;
/**
* Set accessibility description.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilityDescription?: ResourceStr;
/**
* Called when suffix icon is clicked.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public action?: VoidCallback;
/**
* The constructor of ChipV2SuffixImageIcon
*
* @param { ChipV2SuffixImageIconConfig } config - config of suffix icon
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2SuffixImageIconConfig);
}
/**
* Defines chipV2 icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export abstract class ChipV2Icon {
/**
* The constructor of ChipV2Icon
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor();
}
/**
* Defines prefix icon option.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2PrefixImageIconConfig extends ChipV2ImageIconConfig {}
/**
* Defines prefix icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export declare class ChipV2PrefixImageIcon extends ChipV2ImageIcon {
/**
* The constructor of ChipV2PrefixImageIcon
*
* @param { ChipV2PrefixImageIconConfig } config - config of prefix icon
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2PrefixImageIconConfig);
}
/**
* Defines accessibility config.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2AccessibilityConfig {
/**
* Set accessibility level.
*
* @default auto
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
accessibilityLevel?: string;
/**
* Set accessibility text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
accessibilityText?: ResourceStr;
/**
* Set accessibility description.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
accessibilityDescription?: ResourceStr;
}
/**
* Defines accessibility.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export declare class ChipV2Accessibility {
/**
* Set accessibility level.
*
* @default auto
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilityLevel?: string;
/**
* Set accessibility text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilityText?: ResourceStr;
/**
* Set accessibility description.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilityDescription?: ResourceStr;
/**
* The constructor of ChipV2Accessibility
*
* @param { ChipV2AccessibilityConfig } config - config of accessibility. config is mandatory.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2AccessibilityConfig);
}
/**
* Defines config of default close icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2CloseConfig extends ChipV2AccessibilityConfig {
/**
* Set font size for the close icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
fontSize?: LengthMetrics;
}
/**
* Defines default close icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export declare class ChipV2CloseIcon extends ChipV2Accessibility {
/**
* Set font size for the close icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public fontSize?: LengthMetrics;
/**
* The constructor of ChipV2CloseIcon
*
* @param { ChipV2CloseConfig } config - config of close icon
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2CloseConfig);
}
/**
* Defines chip symbol icon config.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2SymbolIconConfig {
/**
* Symbol normal.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
normal?: SymbolGlyphModifier;
/**
* Symbol activated.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
activated?: SymbolGlyphModifier;
}
/**
* Defines chip symbol icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export abstract class ChipV2SymbolIcon extends ChipV2Icon {
/**
* Symbol normal.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public normal?: SymbolGlyphModifier;
/**
* Symbol activated.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public activated?: SymbolGlyphModifier;
/**
* The constructor of ChipV2SymbolIcon
*
* @param { ChipV2SymbolIconConfig } config - config of chip symbol icon
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2SymbolIconConfig);
}
/**
* Defines chip prefix symbol icon config.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2PrefixSymbolIconConfig extends ChipV2SymbolIconConfig {}
/**
* Defines chip prefix symbol icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export declare class ChipV2PrefixSymbolIcon extends ChipV2SymbolIcon {
/**
* The constructor of ChipV2PrefixSymbolIcon
*
* @param { ChipV2PrefixSymbolIconConfig } config - config of chip prefix symbol icon
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2PrefixSymbolIconConfig);
}
/**
* Defines accessibility config of suffix symbol.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2SuffixSymbolIconConfig extends ChipV2SymbolIconConfig {
/**
* Set normal accessibility config for suffix symbol.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
normalAccessibility?: ChipV2AccessibilityConfig;
/**
* Set activated accessibility config for suffix symbol.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
activatedAccessibility?: ChipV2AccessibilityConfig;
/**
* Called when suffix symbol is clicked.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
action?: VoidCallback;
}
/**
* Defines accessibility of suffix symbol.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export declare class ChipV2SuffixSymbolIcon extends ChipV2SymbolIcon {
/**
* Set normal accessibility config for suffix symbol.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public normalAccessibility?: ChipV2Accessibility;
/**
* Set activated accessibility config for suffix symbol.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public activatedAccessibility?: ChipV2Accessibility;
/**
* Called when suffix symbol is clicked.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public action?: VoidCallback;
/**
* The constructor of ChipV2SuffixSymbolIcon
*
* @param { ChipV2SuffixSymbolIconConfig } config - config of suffix symbol
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2SuffixSymbolIconConfig);
}
/**
* Defines label margin.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2LabelMarginConfig {
/**
* Left label margin length.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
left?: LengthMetrics;
/**
* Right label margin length.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
right?: LengthMetrics;
}
/**
* Defines localized label margin.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2LocalizedLabelMarginConfig {
/**
* start localized label margin length.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
start?: LengthMetrics;
/**
* end localized label margin length.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
end?: LengthMetrics;
}
/**
* Defines label config.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface ChipV2LabelConfig {
/**
* Text content.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
text: string;
/**
* Text font size.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
fontSize?: LengthMetrics;
/**
* Text font color.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
fontColor?: ColorMetrics;
/**
* Text font color when chip is activated.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
activatedFontColor?: ColorMetrics;
/**
* Text font family.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
fontFamily?: string;
/**
* Label margin.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
labelMargin?: ChipV2LabelMarginConfig;
/**
* Localized label margin.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
localizedLabelMargin?: ChipV2LocalizedLabelMarginConfig;
/**
* Modifier for the label text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
modifier?: TextModifier;
}
/**
* Defines chip label class.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export declare class ChipV2Label {
/**
* Text content.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public text: string;
/**
* Text font size.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public fontSize?: LengthMetrics;
/**
* Text font color.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public fontColor?: ColorMetrics;
/**
* Text font color when chip is activated.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public activatedFontColor?: ColorMetrics;
/**
* Text font family.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public fontFamily?: string;
/**
* Label margin.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public labelMargin?: ChipV2LabelMarginConfig;
/**
* Localized label margin.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public localizedLabelMargin?: ChipV2LocalizedLabelMarginConfig;
/**
* Modifier for the label text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public modifier?: TextModifier;
/**
* The constructor of ChipLabel
*
* @param { ChipV2LabelConfig } config - config of the chip label
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: ChipV2LabelConfig);
}
/**
* Defines ChipV2 options interface.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
export interface IChipV2OptionsConfig {
/**
* Chip label.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
label: ChipV2Label;
/**
* Chip prefix icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
prefixIcon?: ChipV2Icon;
/**
* Chip suffix icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
suffixIcon?: ChipV2Icon;
/**
* Show close icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
allowClose?: boolean;
/**
* Set config for default close icon when 'allowClose' is true.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
closeIcon?: ChipV2CloseIcon;
/**
* Enable chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
enabled?: boolean;
/**
* Set whether chip is active or not.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
activated?: boolean;
/**
* Chip background color.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
backgroundColor?: ColorMetrics;
/**
* Chip background color when chip is activated.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
activatedBackgroundColor?: ColorMetrics;
/**
* Chip radius.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
borderRadius?: LengthMetrics;
/**
* Chip size.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
size?: ChipV2Size | SizeT<LengthMetrics>;
/**
* Indicates the attribute of the current chip direction.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
direction?: Direction;
/**
* Set accessibility description for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
accessibilityDescription?: ResourceStr;
/**
* Set accessibility level for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
accessibilityLevel?: string;
/**
* Set accessibility selected type for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
accessibilitySelectedType?: ChipV2AccessibilitySelectedType;
/**
* Maximum font scale for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
maxFontScale?: number | Resource;
/**
* Minimum font scale for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
minFontScale?: number | Resource;
/**
* Chip padding.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
padding?: LocalizedPadding;
/**
* Set font size for the label text and the close icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
fontSize?: LengthMetrics;
/**
* Set system-styled materials for the component. Different materials have different effects, which can influence
* the backgroundColor, border, shadow, and other visual attributes of the component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
backgroundSystemMaterial?: uiMaterial.Material;
/**
* Set system-styled materials for the component which is activated. Different materials have different effects,
* which can influence the backgroundColor, border, shadow, and other visual attributes of the component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
activatedBackgroundSystemMaterial?: uiMaterial.Material;
/**
* On close action.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
onClose?: VoidCallback;
/**
* On clicked action.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
onClicked?: Callback<void>;
}
/**
* Defines chip options class.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ObservedV2
export class ChipV2Options {
/**
* Chip prefix icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public label: ChipV2Label;
/**
* Chip prefix icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public prefixIcon?: ChipV2Icon;
/**
* Chip suffix icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public suffixIcon?: ChipV2Icon;
/**
* Show close icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public allowClose?: boolean;
/**
* Set config for default close icon when 'allowClose' is true.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public closeIcon?: ChipV2CloseIcon;
/**
* Enable chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public enabled?: boolean;
/**
* Set whether chip is active or not.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public activated?: boolean;
/**
* Chip background color.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public backgroundColor?: ColorMetrics;
/**
* Chip background color when chip is activated.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public activatedBackgroundColor?: ColorMetrics;
/**
* Chip radius.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public borderRadius?: LengthMetrics;
/**
* Chip size.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public size?: ChipV2Size | SizeT<LengthMetrics>;
/**
* Indicates the attribute of the current chip direction.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public direction?: Direction;
/**
* Set accessibility description for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilityDescription?: ResourceStr;
/**
* Set accessibility level for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilityLevel?: string;
/**
* Sets the accessibility selection type for the chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public accessibilitySelectedType?: ChipV2AccessibilitySelectedType;
/**
* Maximum font scale for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public maxFontScale?: number | Resource;
/**
* Minimum font scale for Chip.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public minFontScale?: number | Resource;
/**
* Chip padding.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public padding?: LocalizedPadding;
/**
* Set font size for the label text and the close icon.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public fontSize?: LengthMetrics;
/**
* Set system-styled materials for the component. Different materials have different effects, which can influence
* the backgroundColor, border, shadow, and other visual attributes of the component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public backgroundSystemMaterial?: uiMaterial.Material;
/**
* Set system-styled materials for the component which is activated. Different materials have different effects,
* which can influence the backgroundColor, border, shadow, and other visual attributes of the component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Trace
public activatedBackgroundSystemMaterial?: uiMaterial.Material;
/**
* On close action.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
public onClose?: VoidCallback;
/**
* On clicked action.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
public onClicked?: Callback<void>;
/**
* The constructor of ChipV2Options
*
* @param { IChipV2OptionsConfig } config - config of the ChipV2Options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
constructor(config: IChipV2OptionsConfig);
}
/**
* Defines chip component with V2 state management.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@ComponentV2
export declare struct ChipV2 {
/**
* Chip options.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
@Require
@Param
readonly chipV2Options: ChipV2Options;
/**
* Sets the build function of the ChipV2.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @atomicservice
* @since 26.0.0 dynamic
*/
build(): void;
}