mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
popup api
Signed-off-by: huangdong57 <huangdong57@huawei.com>
This commit is contained in:
huangdong57
parent
f63992145f
commit
521a272bb6
61
api/@internal/component/ets/common.d.ts
vendored
61
api/@internal/component/ets/common.d.ts
vendored
@ -9132,6 +9132,47 @@ declare interface PopupOptions {
|
||||
* @since 11
|
||||
*/
|
||||
offset?: Position
|
||||
|
||||
/**
|
||||
* Set the background color of the popup.
|
||||
*
|
||||
* @type { ?(Color | string | Resource | number) }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
popupColor?: Color | string | Resource | number;
|
||||
|
||||
/**
|
||||
* Whether hide popup when click mask
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @default true
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
autoCancel?: boolean;
|
||||
|
||||
/**
|
||||
* Set the width of the popup.
|
||||
*
|
||||
* @type { ?Dimension }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
width?: Dimension;
|
||||
|
||||
/**
|
||||
* The position of the sharp corner of popup.
|
||||
*
|
||||
* @type { ?ArrowPointPosition }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
arrowPointPosition?: ArrowPointPosition;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -9457,6 +9498,26 @@ declare interface CustomPopupOptions {
|
||||
* @since 11
|
||||
*/
|
||||
offset?: Position
|
||||
|
||||
/**
|
||||
* Set the width of the popup.
|
||||
*
|
||||
* @type { ?Dimension }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
width?: Dimension;
|
||||
|
||||
/**
|
||||
* The position of the sharp corner of popup.
|
||||
*
|
||||
* @type { ?ArrowPointPosition }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
arrowPointPosition?: ArrowPointPosition;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
37
api/@internal/component/ets/enums.d.ts
vendored
37
api/@internal/component/ets/enums.d.ts
vendored
@ -7284,6 +7284,43 @@ declare enum Placement {
|
||||
RightBottom,
|
||||
}
|
||||
|
||||
/**
|
||||
* ArrowPointPosition enumeration description
|
||||
*
|
||||
* @enum { string }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
declare enum ArrowPointPosition {
|
||||
/**
|
||||
* Target start position
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
START = 'Start',
|
||||
|
||||
/**
|
||||
* Target center position
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
CENTER = 'Center',
|
||||
|
||||
/**
|
||||
* Target end position
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
END = 'End',
|
||||
}
|
||||
|
||||
/**
|
||||
* Indicates the share option.
|
||||
*
|
||||
|
||||
233
api/@ohos.arkui.advanced.Popup.d.ets
Normal file
233
api/@ohos.arkui.advanced.Popup.d.ets
Normal file
@ -0,0 +1,233 @@
|
||||
/*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the popup text options
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
export interface PopupTextOptions {
|
||||
/**
|
||||
* Set the text display content.
|
||||
* @type { ResourceStr }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
text: ResourceStr;
|
||||
|
||||
/**
|
||||
* Set the text font size.
|
||||
* @type { ?(number | string | Resource) }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
fontSize?: number | string | Resource;
|
||||
|
||||
/**
|
||||
* Set the text font color.
|
||||
* @type { ?ResourceColor }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
fontColor?: ResourceColor;
|
||||
|
||||
/**
|
||||
* Set the text font weight.
|
||||
* @type { ?(number | FontWeight | string) }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
fontWeight?: number | FontWeight | string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the popup button options
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
export interface PopupButtonOptions {
|
||||
/**
|
||||
* Set the button display content.
|
||||
* @type { ResourceStr }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
text: ResourceStr;
|
||||
|
||||
/**
|
||||
* Set the button callback.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
action?: () => void;
|
||||
|
||||
/**
|
||||
* Set the button font size.
|
||||
* @type { ?(number | string | Resource) }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
fontSize?: number | string | Resource;
|
||||
|
||||
/**
|
||||
* Set the button font color.
|
||||
* @type { ?ResourceColor }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
fontColor?: ResourceColor;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the popup icon options
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
export interface PopupIconOptions {
|
||||
/**
|
||||
* Set the icon image.
|
||||
* @type { PixelMap | ResourceStr | DrawableDescriptor }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
image: PixelMap | ResourceStr | DrawableDescriptor;
|
||||
|
||||
/**
|
||||
* Set the icon width.
|
||||
* @type { ?Dimension }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
width?: Dimension;
|
||||
|
||||
/**
|
||||
* Set the icon height.
|
||||
* @type { ?Dimension }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
height?: Dimension;
|
||||
|
||||
/**
|
||||
* Set the icon fill color.
|
||||
* @type { ?ResourceColor }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
fillColor?: ResourceColor;
|
||||
|
||||
/**
|
||||
* Set the icon border radius.
|
||||
* @type { ?(Length | BorderRadiuses) }.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
borderRadius?: Length | BorderRadiuses;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the popup options.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
export interface PopupOptions {
|
||||
/**
|
||||
* The icon of Popup.
|
||||
*
|
||||
* @type { ?PopupIconOptions }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
icon?: PopupIconOptions;
|
||||
|
||||
/**
|
||||
* The title of Popup.
|
||||
*
|
||||
* @type { ?PopupTextOptions }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
title?: PopupTextOptions;
|
||||
|
||||
/**
|
||||
* The message of Popup.
|
||||
*
|
||||
* @type { PopupTextOptions }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
message: PopupTextOptions;
|
||||
|
||||
/**
|
||||
* The show close of Popup.
|
||||
*
|
||||
* @type { ?(boolean | Resource) }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
showClose?: boolean | Resource;
|
||||
|
||||
/**
|
||||
* The close button callback of Popup.
|
||||
*
|
||||
* @type { ?() => void }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
onClose?: () => void;
|
||||
|
||||
/**
|
||||
* The buttons of Popup.
|
||||
*
|
||||
* @type { ?[PopupButtonOptions?, PopupButtonOptions?] }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
buttons?: [PopupButtonOptions?, PopupButtonOptions?];
|
||||
}
|
||||
|
||||
/**
|
||||
* Build function of popup.
|
||||
*
|
||||
* @param { PopupOptions } options - popup option.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
@Builder
|
||||
export declare function Popup(options: PopupOptions): void;
|
||||
Loading…
Reference in New Issue
Block a user