• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * Provides an Effect Component, which is invisible, but setting properties on this component defines an effect template
18 * that child components can apply by setting useEffect(true).
19 *
20 * @interface EffectComponentInterface
21 * @syscap SystemCapability.ArkUI.ArkUI.Full
22 * @systemapi
23 * @since 10
24 */
25interface EffectComponentInterface {
26  /**
27   * Return effectComponent.
28   *
29   * @returns { EffectComponentAttribute }
30   * @syscap SystemCapability.ArkUI.ArkUI.Full
31   * @systemapi
32   * @since 10
33   */
34  (): EffectComponentAttribute;
35}
36
37/**
38 * Defines the Effect Component attribute functions.
39 *
40 * @extends CommonMethod
41 * @syscap SystemCapability.ArkUI.ArkUI.Full
42 * @systemapi
43 * @since 10
44 */
45declare class EffectComponentAttribute extends CommonMethod<EffectComponentAttribute> {}
46
47/**
48 * Defines Effect Component.
49 *
50 * @syscap SystemCapability.ArkUI.ArkUI.Full
51 * @systemapi
52 * @since 10
53 */
54declare const EffectComponent: EffectComponentInterface;
55
56/**
57 * Defines Effect Component instance.
58 *
59 * @syscap SystemCapability.ArkUI.ArkUI.Full
60 * @systemapi
61 * @since 10
62 */
63declare const EffectComponentInstance: EffectComponentAttribute;
64