xref: /interface/sdk-js/api/@internal/component/ets/security_component.d.ts

/*
 * Copyright (c) 2023 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
 */

/**
 * Enumerates the layout direction of the icon and text.
 *
 * @enum { number }
 * @syscap SystemCapability.ArkUI.ArkUI.Full
 * @since 10
 */
/**
 * Enumerates the layout direction of the icon and text.
 *
 * @enum { number }
 * @syscap SystemCapability.ArkUI.ArkUI.Full
 * @atomicservice
 * @since 11
 */
declare enum SecurityComponentLayoutDirection {
  /**
   * Horizontal layout.
   *
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Horizontal layout.
   *
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  HORIZONTAL = 0,

  /**
   * Vertical layout.
   *
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Vertical layout.
   *
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  VERTICAL = 1
}

/**
 * Defines the method of a security component.
 *
 * @syscap SystemCapability.ArkUI.ArkUI.Full
 * @since 10
 */
/**
 * Defines the method of a security component.
 *
 * @syscap SystemCapability.ArkUI.ArkUI.Full
 * @atomicservice
 * @since 11
 */
declare class SecurityComponentMethod<T> {
  /**
   * Icon size.
   *
   * @param { Dimension } value - Indicates the size of the icon.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Icon size.
   *
   * @param { Dimension } value - Indicates the size of the icon.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  iconSize(value: Dimension): T;

  /**
   * Layout direction of the icon and text.
   *
   * @param { SecurityComponentLayoutDirection } value - Indicates the layout direction of the icon and text.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Layout direction of the icon and text.
   *
   * @param { SecurityComponentLayoutDirection } value - Indicates the layout direction of the icon and text.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  layoutDirection(value: SecurityComponentLayoutDirection): T;

  /**
   * Position of the security component.
   *
   * @param { Position } value - Indicates the position of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Position of the security component.
   *
   * @param { Position } value - Indicates the position of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  position(value: Position): T;

  /**
   * Anchor of the security component for positioning. The top start edge of the component is used as
   * the reference point for offset.
   *
   * @param { Position } value - Indicates the anchor of the component when it is positioned.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Anchor of the security component for positioning. The top start edge of the component is used as
   * the reference point for offset.
   *
   * @param { Position } value - Indicates the anchor of the component when it is positioned.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  markAnchor(value: Position): T;

  /**
   * Coordinate offset relative to the layout position.
   * Setting this attribute does not affect the layout of the parent container.
   * The position is adjusted only during drawing.
   *
   * @param { Position } value - Indicates the offset value.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Coordinate offset relative to the layout position.
   * Setting this attribute does not affect the layout of the parent container.
   * The position is adjusted only during drawing.
   *
   * @param { Position } value - Indicates the offset value.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  /**
   * Coordinate offset relative to the layout completion position.
   * Setting this attribute does not affect the layout of the parent container.
   * The position is adjusted only during drawing.
   *
   * @param { Position | Edges | LocalizedEdges } value
   * @returns { T }
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 12
   */
  offset(value: Position | Edges | LocalizedEdges): T;

  /**
   * Font size of the inner text.
   *
   * @param { Dimension } value - Indicates the font size of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Font size of the inner text.
   *
   * @param { Dimension } value - Indicates the font size of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  fontSize(value: Dimension): T;

  /**
   * Font style of the inner text.
   *
   * @param { FontStyle } value - Indicates the font style of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Font style of the inner text.
   *
   * @param { FontStyle } value - Indicates the font style of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  fontStyle(value: FontStyle): T;

  /**
   * Font weight of the inner text.
   *
   * @param { number | FontWeight | string } value - Indicates the font weight of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Font weight of the inner text.
   *
   * @param { number | FontWeight | string } value - Indicates the font weight of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  fontWeight(value: number | FontWeight | string): T;

  /**
   * Font family of the inner text.
   *
   * @param { string | Resource } value - Indicates the font family of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Font family of the inner text.
   *
   * @param { string | Resource } value - Indicates the font family of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  fontFamily(value: string | Resource): T;

  /**
   * Font color of the inner text.
   *
   * @param { ResourceColor } value - Indicates the font color of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Font color of the inner text.
   *
   * @param { ResourceColor } value - Indicates the font color of the text in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  fontColor(value: ResourceColor): T;

  /**
   * Color of the icon.
   *
   * @param { ResourceColor } value - Indicates the icon color in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Color of the icon.
   *
   * @param { ResourceColor } value - Indicates the icon color in the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  iconColor(value: ResourceColor): T;

  /**
   * Background color.
   *
   * @param { ResourceColor } value - Indicates the background color of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Background color.
   *
   * @param { ResourceColor } value - Indicates the background color of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  backgroundColor(value: ResourceColor): T;

  /**
   * Style of the border.
   *
   * @param { BorderStyle } value - Indicates the border style of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Style of the border.
   *
   * @param { BorderStyle } value - Indicates the border style of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  borderStyle(value: BorderStyle): T;

  /**
   * Width of the border.
   *
   * @param { Dimension } value - Indicates the border width of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Width of the border.
   *
   * @param { Dimension } value - Indicates the border width of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  borderWidth(value: Dimension): T;

  /**
   * Color of the border.
   *
   * @param { ResourceColor } value - Indicates the border color of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Color of the border.
   *
   * @param { ResourceColor } value - Indicates the border color of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  borderColor(value: ResourceColor): T;

  /**
   * Radius of the border.
   *
   * @param { Dimension } value - Indicates the border radius of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Radius of the border.
   *
   * @param { Dimension } value - Indicates the border radius of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  borderRadius(value: Dimension): T;

  /**
   * Padding between the background border and icon/inner text.
   *
   * @param { Padding | Dimension } value - Indicates the padding of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Padding between the background border and icon/inner text.
   *
   * @param { Padding | Dimension } value - Indicates the padding of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  padding(value: Padding | Dimension): T;

  /**
   * Space between the inner text and icon.
   *
   * @param { Dimension } value - Indicates the space between the inner text and icon.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 10
   */
  /**
   * Space between the inner text and icon.
   *
   * @param { Dimension } value - Indicates the space between the inner text and icon.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 11
   */
  textIconSpace(value: Dimension): T;

  /**
   * Key. User can set an key to the component to identify it.
   *
   * @param { string } value - identify the key of the component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @systemapi
   * @since 10
   * @test
   */
  key(value: string): T;

  /**
   * Sets the width of the component.
   *
   * @param { Length } value - Indicates the width of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 11
   */
  /**
   * Sets the width of the component.
   *
   * @param { Length } value - Indicates the width of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 12
   */
  width(value: Length): T;

  /**
   * Sets the height of the component.
   *
   * @param { Length } value - Indicates the height of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 11
   */
  /**
   * Sets the height of the component.
   *
   * @param { Length } value - Indicates the height of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 12
   */
  height(value: Length): T;

  /**
   * The size of the component.
   *
   * @param { SizeOptions } value - Indicates the size of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 11
   */
  /**
   * The size of the component.
   *
   * @param { SizeOptions } value - Indicates the size of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 12
   */
  size(value: SizeOptions): T;

  /**
   * constraint Size:
   * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height.
   *
   * @param { ConstraintSizeOptions } value - Indicates the constraint size of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @since 11
   */
  /**
   * constraint Size:
   * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height.
   *
   * @param { ConstraintSizeOptions } value - Indicates the constraint size of the security component.
   * @returns { T } Returns the attribute of the security component.
   * @syscap SystemCapability.ArkUI.ArkUI.Full
   * @atomicservice
   * @since 12
   */
  constraintSize(value: ConstraintSizeOptions): T;
}