• 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 * @file
18 * @kit ArkUI
19 */
20
21/**
22 * Provides an Effect Component, which is invisible, but setting properties on this component defines an effect template
23 * that child components can apply by setting useEffect(true).
24 *
25 * @interface EffectComponentInterface
26 * @syscap SystemCapability.ArkUI.ArkUI.Full
27 * @systemapi
28 * @since 10
29 */
30interface EffectComponentInterface {
31  /**
32   * Return effectComponent.
33   *
34   * @returns { EffectComponentAttribute }
35   * @syscap SystemCapability.ArkUI.ArkUI.Full
36   * @systemapi
37   * @since 10
38   */
39  (): EffectComponentAttribute;
40}
41
42/**
43 * Defines the Effect Component attribute functions.
44 *
45 * @extends CommonMethod<EffectComponentAttribute>
46 * @syscap SystemCapability.ArkUI.ArkUI.Full
47 * @systemapi
48 * @since 10
49 */
50declare class EffectComponentAttribute extends CommonMethod<EffectComponentAttribute> {}
51
52/**
53 * Defines Effect Component.
54 *
55 * @syscap SystemCapability.ArkUI.ArkUI.Full
56 * @systemapi
57 * @since 10
58 */
59declare const EffectComponent: EffectComponentInterface;
60
61/**
62 * Defines Effect Component instance.
63 *
64 * @syscap SystemCapability.ArkUI.ArkUI.Full
65 * @systemapi
66 * @since 10
67 */
68declare const EffectComponentInstance: EffectComponentAttribute;
69