Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
c80db68e
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
c80db68e
编写于
12月 02, 2022
作者:
O
openharmony_ci
提交者:
Gitee
12月 02, 2022
浏览文件
操作
浏览文件
下载
差异文件
!12062 格式修改
Merge pull request !12062 from LiAn/master
上级
273688db
57306b93
变更
4
显示空白变更内容
内联
并排
Showing
4 changed file
with
279 addition
and
283 deletion
+279
-283
zh-cn/application-dev/reference/apis/js-apis-i18n.md
zh-cn/application-dev/reference/apis/js-apis-i18n.md
+79
-79
zh-cn/application-dev/reference/apis/js-apis-intl.md
zh-cn/application-dev/reference/apis/js-apis-intl.md
+36
-36
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md
...ication-dev/reference/arkui-ts/ts-basic-components-web.md
+4
-8
zh-cn/application-dev/reference/arkui-ts/ts-state-management.md
...application-dev/reference/arkui-ts/ts-state-management.md
+160
-160
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @
c80db68e
...
...
@@ -45,7 +45,7 @@ static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -84,7 +84,7 @@ static getDisplayLanguage(language: string, locale: string, sentenceCase?: boole
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -115,7 +115,7 @@ static getSystemLanguages(): Array<string>
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -137,9 +137,9 @@ static getSystemCountries(language: string): Array<string>
**参数:**
| 参数名 | 类型 | 说明 |
| -------- | ------ | ----- |
| language | string | 语言ID。 |
| 参数名 | 类型 |
必填 |
说明 |
| -------- | ------ | ----
| ----
- |
| language | string |
是 |
语言ID。 |
**返回值:**
...
...
@@ -152,7 +152,7 @@ static getSystemCountries(language: string): Array<string>
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -190,7 +190,7 @@ static isSuggested(language: string, region?: string): boolean
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -221,7 +221,7 @@ static getSystemLanguage(): string
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -247,16 +247,16 @@ static setSystemLanguage(language: string): void
**参数:**
| 参数名 | 类型 | 说明 |
| -------- | ------ | ----- |
| language | string | 语言ID。 |
| 参数名 | 类型 |
必填 |
说明 |
| -------- | ------ | ----
| ----
- |
| language | string |
是 |
语言ID。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -287,7 +287,7 @@ static getSystemRegion(): string
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -313,16 +313,16 @@ static setSystemRegion(region: string): void
**参数:**
| 参数名 | 类型 | 说明 |
| ------ | ------ | ----- |
| region | string | 地区ID。 |
| 参数名 | 类型 |
必填 |
说明 |
| ------ | ------ | ----
| ----
- |
| region | string |
是 |
地区ID。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -353,7 +353,7 @@ static getSystemLocale(): string
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -379,16 +379,16 @@ static setSystemLocale(locale: string): void
**参数:**
| 参数名 | 类型 | 说明 |
| ------ | ------ | --------------- |
| locale | string | 指定区域ID,例如zh-CN。 |
| 参数名 | 类型 |
必填 |
说明 |
| ------ | ------ | ----
| ----
----------- |
| locale | string |
是 |
指定区域ID,例如zh-CN。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -419,7 +419,7 @@ static is24HourClock(): boolean
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -454,7 +454,7 @@ static set24HourClock(option: boolean): void
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -491,7 +491,7 @@ static addPreferredLanguage(language: string, index?: number): void
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -529,7 +529,7 @@ static removePreferredLanguage(index: number): void
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -562,7 +562,7 @@ static getPreferredLanguageList(): Array<string>
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -593,7 +593,7 @@ static getFirstPreferredLanguage(): string
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -624,7 +624,7 @@ static getAppPreferredLanguage(): string
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -659,7 +659,7 @@ static setUsingLocalDigit(flag: boolean): void
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -690,7 +690,7 @@ static getUsingLocalDigit(): boolean
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------
-- | ------------------
---------------------- |
| ------
|
---------------------- |
| 890001 | Unspported para value. |
**示例:**
...
...
@@ -713,9 +713,9 @@ isRTL(locale: string): boolean
**参数:**
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------- |
| locale | string | 指定区域ID。 |
| 参数名 | 类型 |
必填 |
说明 |
| ------ | ------ | ----
| ----
--- |
| locale | string |
是 |
指定区域ID。 |
**返回值:**
...
...
@@ -905,7 +905,7 @@ setFirstDayOfWeek(value: number): void
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | --------------------- |
| value | number |
否
| 设置一周的起始日,1代表周日,7代表周六。 |
| value | number |
是
| 设置一周的起始日,1代表周日,7代表周六。 |
**示例:**
```
js
...
...
@@ -947,7 +947,7 @@ setMinimalDaysInFirstWeek(value: number): void
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------------ |
| value | number |
否
| 一年中第一周的最小天数。 |
| value | number |
是
| 一年中第一周的最小天数。 |
**示例:**
```
js
...
...
@@ -1153,7 +1153,7 @@ getLocationName(number: string, locale: string): string
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| ---- | ------ | ---- | ---- | ---------------------------------------- |
| type | string | 是 | 是 | 表示对电话号码格式化的类型,取值范围:"E164",
"INTERNATIONAL",
"NATIONAL",
"RFC3966"。 |
...
...
@@ -1164,7 +1164,7 @@ getLocationName(number: string, locale: string): string
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- |
| unit | string | 是 | 是 | 单位的名称,如:"meter",
"inch",
"cup"等。 |
| measureSystem | string | 是 | 是 | 单位的度量体系,取值包括:"SI",
"US",
"UK"。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-intl.md
浏览文件 @
c80db68e
...
...
@@ -21,9 +21,9 @@ import Intl from '@ohos.intl';
### 属性
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Global.I18n
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
| language | string | 是 | 否 | 与区域设置关联的语,
如:zh。 |
| script | string | 是 | 否 | 语言的书写方式,如:Hans。 |
...
...
@@ -62,7 +62,7 @@ constructor(locale: string, options?: LocaleOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------
|
------------- | ---- | ---------------------------- |
| -------
------------- | -------------------
------------- | ---- | ---------------------------- |
| locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options
<sup>
9+
</sup>
|
[
LocaleOptions
](
#localeoptions9
)
| 否 | 用于创建区域对象的选项。 |
...
...
@@ -141,7 +141,7 @@ minimize(): Locale
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
| calendar | string | 是 | 是 | 日历参数,如:"buddhist", "chinese", "coptic", "dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 |
| collation | string | 是 | 是 | 排序参数,取值包括:"big5han", "compat", "dict", "direct", "ducet", "emoji", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed ", "search", "searchjl", "standard", "stroke", "trad", "unihan", "zhuyin"。 |
...
...
@@ -179,7 +179,7 @@ constructor(locale: string | Array<string>, options?: DateTimeOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------
|
----------------------------------- | ---- | ---------------------------- |
| -------
------------- | -
----------------------------------- | ---- | ---------------------------- |
| locale | string
\|
Array
<
string
>
| 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options
<sup>
9+
</sup>
|
[
DateTimeOptions
](
#datetimeoptions9
)
| 否 | 用于创建时间日期格式化的选项。 |
...
...
@@ -264,7 +264,7 @@ resolvedOptions(): DateTimeOptions
**返回值:**
| 类型 | 说明 |
| ----------------------------------- | ----------------------------- |
| -----------------------------------
-
| ----------------------------- |
|
[
DateTimeOptions
](
#datetimeoptions9
)
| DateTimeFormat
对象的格式化选项。 |
**示例:**
...
...
@@ -280,7 +280,7 @@ resolvedOptions(): DateTimeOptions
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 否 | 区域参数,
如:zh-Hans-CN。 |
| dateStyle | string | 是 | 是 | 日期显示格式,取值包括:"long",
"short",
"medium",
"full"。 |
...
...
@@ -331,7 +331,7 @@ constructor(locale: string | Array<string>, options?: NumberOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------
|
------------------------------- | ---- | ---------------------------- |
| -------
------------- | -
------------------------------- | ---- | ---------------------------- |
| locale | string
\|
Array
<
string
>
| 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options
<sup>
9+
</sup>
|
[
NumberOptions
](
#numberoptions9
)
| 否 | 用于创建数字格式化的选项。 |
...
...
@@ -380,7 +380,7 @@ resolvedOptions(): NumberOptions
**返回值:**
| 类型 | 说明 |
| ------------------------------- | --------------------------- |
| -------------------------------
-
| --------------------------- |
|
[
NumberOptions
](
#numberoptions9
)
| NumberFormat
对象的格式化选项。 |
...
...
@@ -395,9 +395,9 @@ resolvedOptions(): NumberOptions
表示设备支持的能力。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Global.I18n
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| ------------------------ | ------- | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 否 | 区域参数,
如:"zh-Hans-CN"。 |
| currency | string | 是 | 是 | 货币单位,
如:"EUR","CNY","USD"等。 |
...
...
@@ -448,7 +448,7 @@ constructor(locale: string | Array<string>, options?: CollatorOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------
|
----------------------------------- | ---- | ---------------------------- |
| -------
------------- | -
----------------------------------- | ---- | ---------------------------- |
| locale | string
\|
Array
<
string
>
| 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options
<sup>
9+
</sup>
|
[
CollatorOptions
](
#collatoroptions9
)
| 否 | 用于创建排序对象的选项。 |
...
...
@@ -497,7 +497,7 @@ resolvedOptions(): CollatorOptions
**返回值:**
| 类型 | 说明 |
| ----------------------------------- | ----------------- |
| -----------------------------------
-
| ----------------- |
|
[
CollatorOptions
](
#collatoroptions9
)
| 返回的Collator对象的属性。 |
**示例:**
...
...
@@ -513,7 +513,7 @@ resolvedOptions(): CollatorOptions
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| ----------------- | ------- | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值范围:"best
fit",
"lookup"。 |
| usage | string | 是 | 是 | 比较的用途,取值范围:"sort",
"search"。 |
...
...
@@ -552,7 +552,7 @@ constructor(locale: string | Array<string>, options?: PluralRulesOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ---------------------------- |
| -------
-------------
| ---------------------------------------- | ---- | ---------------------------- |
| locale | string
\|
Array
<
string
>
| 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options
<sup>
9+
</sup>
|
[
PluralRulesOptions
](
#pluralrulesoptions9
)
| 否 | 用于创建单复数对象的选项。 |
...
...
@@ -595,7 +595,7 @@ select(n: number): string
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best
fit",
"lookup"。 |
| type | string | 是 | 是 | 排序的类型,取值包括:"cardinal",
"ordinal"。 |
...
...
@@ -634,7 +634,7 @@ constructor(locale: string | Array<string>, options?: RelativeTimeFormatIn
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ---------------------------- |
| -------
-------------
| ---------------------------------------- | ---- | ---------------------------- |
| locale | string
\|
Array
<
string
>
| 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options
<sup>
9+
</sup>
|
[
RelativeTimeFormatInputOptions
](
#relativetimeformatinputoptions9
)
| 否 | 用于创建相对时间格式化对象的选项。 |
...
...
@@ -727,7 +727,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best
fit",
"lookup"。 |
| numeric | string | 是 | 是 | 输出消息的格式,取值包括:"always",
"auto"。 |
...
...
@@ -740,7 +740,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**
:SystemCapability.Global.I18n
| 名称 |
参数类型
| 可读 | 可写 | 说明 |
| 名称 |
类型
| 可读 | 可写 | 说明 |
| --------------- | ------ | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| numeric | string | 是 | 是 | 输出消息的格式,取值包括:"always",
"auto"。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md
浏览文件 @
c80db68e
# Web
提供具有网页显示能力的Web组件。
> **说明:**
>
> - 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> - 示例效果请以真机运行为准,当前IDE预览器不支持。
提供具有网页显示能力的Web组件。
## 需要权限
访问在线网页时需添加网络权限:ohos.permission.INTERNET,具体申请方式请参考
[
权限申请声明
](
../../security/accesstoken-guidelines.md
)
。
...
...
@@ -27,7 +27,7 @@ Web(options: { src: ResourceStr, controller: WebController | WebviewController})
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ---------- | ---------------------------------------- | ---- | ------- |
| src |
[
ResourceStr
](
ts-types.md
)
| 是 | 网页资源地址。 |
| controller |
[
WebController
](
#webcontroller
)
或
[
WebviewController
](
../apis/js-apis-webview.md#webviewcontroller
)
| 是 | 控制器。 |
| controller |
[
WebController
](
#webcontroller
)
\|
[
WebviewController<sup>9+</sup>
](
../apis/js-apis-webview.md#webviewcontroller
)
| 是 | 控制器。 |
**示例:**
...
...
@@ -88,7 +88,7 @@ Web(options: { src: ResourceStr, controller: WebController | WebviewController})
## 属性
web组件的网络属性
。
通用属性仅支持
[
width
](
ts-universal-attributes-size.md#属性
)
、
[
height
](
ts-universal-attributes-size.md#属性
)
、
[
padding
](
ts-universal-attributes-size.md#属性
)
、
[
margin
](
ts-universal-attributes-size.md#属性
)
、
[
border
](
ts-universal-attributes-border.md#属性
)
。
### domStorageAccess
...
...
@@ -672,10 +672,6 @@ webDebuggingAccess(webDebuggingAccess: boolean)
}
```
> **说明:**
>
> 通用属性仅支持[width](ts-universal-attributes-size.md#属性)、[height](ts-universal-attributes-size.md#属性)、[padding](ts-universal-attributes-size.md#属性)、[margin](ts-universal-attributes-size.md#属性)、[border](ts-universal-attributes-border.md#属性)。
## 事件
不支持通用事件。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-state-management.md
浏览文件 @
c80db68e
...
...
@@ -17,13 +17,13 @@ Link(propName: string): any
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| ----------
----------- |
| -------- | ------ | ---
- |
----------- |
| propName | string | 是 | 要双向绑定的属性名称。 |
**返回值:**
| 类型 | 描述 |
| ----- | ----------------------------------------
--------------------
|
| ----- | ---------------------------------------- |
| @Link | 在具有给定键的数据,则返回到此属性的双向数据绑定,该双向绑定意味着变量或者组件对数据的更改将同步到AppStorage,通过AppStorage对数据的修改将同步到变量或者组件。 |
```
ts
...
...
@@ -39,14 +39,14 @@ SetAndLink\<T>(propName: string, defaultValue: T): SubscribedAbstractProperty\<T
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | ---
| ---------
----------- |
| ------------ | ------ | ---
- |
----------- |
| propName | string | 是 | 要进行创建的key值。 |
| defaultValue | T | 是 | 要进行设置的默认值。 |
**返回值:**
| 类型 | 描述 |
| ----- | ----------------------------------------
--------------------
|
| ----- | ---------------------------------------- |
| @Link | 与Link接口类似,如果当前的key保存于AppStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Link返回。 |
```
ts
...
...
@@ -62,13 +62,13 @@ Prop(propName: string): any
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| --------
----------- |
| -------- | ------ | ---
- |
----------- |
| propName | string | 是 | 要进行创建的key值。 |
**返回值:**
| 类型 | 描述 |
| ----- | ----------------------------------------
--------------------
|
| ----- | ---------------------------------------- |
| @Prop | 如果存在具有给定键的属性,则返回此属性的单向数据绑定。该单向绑定意味着只能通过AppStorage将属性的更改同步到变量或者组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态属性,如果具有此键的属性不存在则返回undefined。 |
```
ts
...
...
@@ -84,14 +84,14 @@ SetAndProp\<S>(propName: string, defaultValue: S): SubscribedAbstractProperty\<S
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | ---
| ------------
--------------- |
| ------------ | ------ | ---
- |
--------------- |
| propName | string | 是 | 要保存的的键值对中的key值。 |
| defaultValue | S | 是 | 创建的默认值。 |
**返回值:**
| 类型 | 描述 |
| ----- | ----------------------------------------
--------------------
|
| ----- | ---------------------------------------- |
| @Prop | 如果当前的key保存与AppStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Prop返回。 |
```
ts
...
...
@@ -107,13 +107,13 @@ Has(propName: string): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| -------
------- |
| -------- | ------ | ---
- |
------- |
| propName | string | 是 | 属性的属性值。 |
**返回值:**
| 类型 | 描述 |
| ------- | -------------
-------------
|
| ------- | ------------- |
| boolean | 返回属性的属性值是否存在。 |
```
ts
...
...
@@ -129,13 +129,13 @@ Get\<T>(propName: string): T | undefined
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---- | -----------
--------
|
| -------- | ------ | ---- | ----------- |
| propName | string | 是 | 要获取对应的key值。 |
**返回值:**
| 类型 | 描述 |
| -----------------
- | -------------
------------- |
| -----------------
|
------------- |
| boolean或undefined | 返回属性的属性值是否存在。 |
```
ts
...
...
@@ -151,14 +151,14 @@ Set\<T>(propName: string, newValue: T): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| ------
----------- |
| -------- | ------ | ---
- |
----------- |
| propName | string | 是 | 要设置的key值。 |
| newValue | T | 是 | 要设置的value值。 |
**返回值:**
| 类型 | 描述 |
| ------- | -----------------------------------
------------------
|
| ------- | ----------------------------------- |
| boolean | 如果存在key值,设置value值并返回true,否则返回false。 |
```
ts
...
...
@@ -174,14 +174,14 @@ SetOrCreate\<T>(propName: string, newValue: T): void
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| ----------
--------------- |
| -------- | ------ | ---
- |
--------------- |
| propName | string | 是 | 要更新或者创建的key值。 |
| newValue | T | 是 | 要更新或者创建的value值。 |
**返回值:**
| 类型 | 描述 |
| ------- | ----------------------------------------
--------------------
|
| ------- | ---------------------------------------- |
| boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在AppStorage中创建具有给定默认值的新属性,默认值必须是T类型。不允许undefined 或 null 返回true。 |
```
ts
...
...
@@ -197,13 +197,13 @@ Delete(propName: string): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| ---------
------------ |
| -------- | ------ | ---
- |
------------ |
| propName | string | 是 | 要删除的属性的key值。 |
**返回值:**
| 类型 | 描述 |
| ------- | ----------------------------------------
--------------------
|
| ------- | ---------------------------------------- |
| boolean | 删除key指定的键值对,如果存在且删除成功返回true,不存在或删除失败返回false。 |
```
ts
...
...
@@ -219,7 +219,7 @@ keys(): IterableIterator\<string>
**返回值:**
| 类型 | 描述 |
| -------------- | --------------
--------------
|
| -------------- | -------------- |
| array
\<
string> | 返回包含所有键的字符串数组。 |
```
ts
...
...
@@ -232,19 +232,19 @@ staticClear(): boolean
删除所有的属性。
**该属性在api9上已废弃,使用Clear属性替代**
从API version 9开始废弃,推荐使用
[
Clear
](
#clear
)
。
**返回值:**
| 类型 | 描述 |
| ------- | ---------------------------------
---------------------------
|
| ------- | --------------------------------- |
| boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 |
```
ts
let
simple
=
AppStorage
.
staticClear
()
```
### Clear
### Clear
<sup>9+</sup>
Clear(): boolean
...
...
@@ -253,7 +253,7 @@ Clear(): boolean
**返回值:**
| 类型 | 描述 |
| ------- | ---------------------------------
---------------------------
|
| ------- | --------------------------------- |
| boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 |
```
typescript
...
...
@@ -269,13 +269,13 @@ IsMutable(propName: string): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | ------------
---------
|
| -------- | ------ | :--- | ------------ |
| propName | string | 是 | 要查询的属性的key值。 |
**返回值:**
| 类型 | 描述 |
| ------- | ------------------
------------------
|
| ------- | ------------------ |
| boolean | 返回此属性是否存在并且是否可以改变。 |
```
ts
...
...
@@ -291,7 +291,7 @@ Size(): number
**返回值:**
| 类型 | 描述 |
| ------ | ---------
---------
|
| ------ | --------- |
| number | 返回键值对的数量。 |
```
ts
...
...
@@ -309,7 +309,7 @@ constructor(initializingProperties?: Object)
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ---------------------- | ------ | ---- | ----------------------------------------
--------------------
|
| ---------------------- | ------ | ---- | ---------------------------------------- |
| initializingProperties | Object | 否 | object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage。 |
```
ts
...
...
@@ -327,7 +327,7 @@ static GetShared(): LocalStorage
**返回值:**
| 类型 | 描述 |
| ----------------------------- | -----------------
-----
|
| ----------------------------- | ----------------- |
|
[
LocalStorage
](
#localstorage
)
| 返回LocalStorage对象。 |
```
ts
...
...
@@ -343,13 +343,13 @@ has(propName: string): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| -------
------- |
| -------- | ------ | ---
- |
------- |
| propName | string | 是 | 属性的属性值。 |
**返回值:**
| 类型 | 描述 |
| ------- | -------------
-------------
|
| ------- | ------------- |
| boolean | 返回属性的属性值是否存在。 |
```
ts
...
...
@@ -366,13 +366,13 @@ get\<T>(propName: string): T
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| --------
----------- |
| -------- | ------ | ---
- |
----------- |
| propName | string | 是 | 要获取对应的key值。 |
**返回值:**
| 类型 | 描述 |
| -------------- | ----------------------------------------
---------------
|
| -------------- | ---------------------------------------- |
| T
\|
undefined | 当keyvalue存在时,返回keyvalue值。不存在返回undefined。 |
```
ts
...
...
@@ -389,14 +389,14 @@ set\<T>(propName: string, newValue: T): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| ------
----------- |
| -------- | ------ | ---
- |
----------- |
| propName | string | 是 | 要设置的key值。 |
| newValue | T | 是 | 要设置的value值。 |
**返回值:**
| 类型 | 描述 |
| ------- | -----------------------------------
------------------
|
| ------- | ----------------------------------- |
| boolean | 如果存在key值,设置value值并返回true,否则返回false。 |
```
ts
...
...
@@ -413,14 +413,14 @@ setOrCreate\<T>(propName: string, newValue: T): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | --------------
---------
|
| -------- | ------ | :--- | -------------- |
| propName | string | 是 | 要更新或创建的key值。 |
| newValue | T | 是 | 要更新或创建的value值。 |
**返回值:**
| 类型 | 描述 |
| ------- | ----------------------------------------
--------------------
|
| ------- | ---------------------------------------- |
| boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在LocalStorage中创建具有给定默认值的新属性,默认值必须是T类型,不允许undefined 或 null 。 |
```
ts
...
...
@@ -437,13 +437,13 @@ link\<T>(propName: string): T
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| -----------
----------- |
| -------- | ------ | ---
- |
----------- |
| propName | string | 是 | 要双向绑定的属性名称。 |
**返回值:**
| 类型 | 描述 |
| ---- | ----------------------------------------
--------------------
|
| ---- | ---------------------------------------- |
| T | 如果存在具有给定键的属性,返回到此属性的双向绑定,该双向绑定意味着变量或者组件对数据的更改将同步到LocalStorage,然后通过LocalStorage实例同步到任何变量或组件。如果不存在给定键的属性,返回undefined。 |
```
ts
...
...
@@ -460,14 +460,14 @@ setAndLink\<T>(propName: string, defaultValue: T): T
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | ---
| ---------
----------- |
| ------------ | ------ | ---
- |
----------- |
| propName | string | 是 | 要进行创建的key值。 |
| defaultValue | T | 是 | 要进行设置的默认值。 |
**返回值:**
| 类型 | 描述 |
| -----
------------------------------- | --------------------
---------------------------------------- |
| -----
|
---------------------------------------- |
| @Link | 与Link接口类似,如果当前的key保存于LocalStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Link返回。 |
```
ts
...
...
@@ -484,13 +484,13 @@ prop\<T>(propName: string): T
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | ---
| ----------
------------- |
| -------- | ------ | ---
- |
------------- |
| propName | string | 是 | 要单向数据绑定的key值。 |
**返回值:**
| 类型 | 描述 |
| -----
------------------------------- | --------------------
---------------------------------------- |
| -----
|
---------------------------------------- |
| @Prop | 如果存在具有给定键的属性,返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 |
```
ts
...
...
@@ -507,14 +507,14 @@ setAndProp\<T>(propName: string, defaultValue: T): T
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | ---
| -----------
-------------- |
| ------------ | ------ | ---
- |
-------------- |
| propName | string | 是 | 要保存的键值对中的key值。 |
| defaultValue | T | 是 | 创建的默认值。 |
**返回值:**
| 类型 | 描述 |
| -----
------------------------------- | --------------------
---------------------------------------- |
| -----
|
---------------------------------------- |
| @Prop | 如果当前的key保存与LocalStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Prop返回。 |
```
ts
...
...
@@ -531,13 +531,13 @@ delete(propName: string): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| -------- | ------ | :--- | ------------
---------
|
| -------- | ------ | :--- | ------------ |
| propName | string | 是 | 要删除的属性的key值。 |
**返回值:**
| 类型 | 描述 |
| ------- | ----------------------------------------
--------------------
|
| ------- | ---------------------------------------- |
| boolean | 删除key指定的键值对。存在且删除成功,返回true。不存在、删除失败或有状态变量依旧引用propName,返回false。 |
```
ts
...
...
@@ -554,7 +554,7 @@ keys(): IterableIterator\<string>
**返回值:**
| 类型 | 描述 |
| -------------- | -------------------
-------------------
|
| -------------- | ------------------- |
| array
\<
string> | 返回包含所有键不可序列化的字符串数组。 |
```
ts
...
...
@@ -571,7 +571,7 @@ size(): number
**返回值:**
| 类型 | 描述 |
| ------ | ---------
---------
|
| ------ | --------- |
| number | 返回键值对的数量。 |
```
ts
...
...
@@ -588,7 +588,7 @@ clear(): boolean
**返回值:**
| 类型 | 描述 |
| ------- | ---------------------------------
---------------------------
|
| ------- | --------------------------------- |
| boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 |
```
ts
...
...
@@ -607,7 +607,7 @@ constructor(appStorage: AppStorage, storage: Storage)
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ---------- | ---------- | ---
| ----------------
---------------- |
| ---------- | ---------- | ---
- |
---------------- |
| appStorage | AppStorage | 是 | 保存所有属性及属性值的单例对象。 |
| storage | Storage | 是 | Storage实例对象。 |
...
...
@@ -624,7 +624,7 @@ PersistProp(key:string,defaultValue:T): void
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ------------ | ------ | ---
| ---------
-------------- |
| ------------ | ------ | ---
- |
-------------- |
| key | string | 是 | 要关联的属性的key值。 |
| defaultValue | T | 是 | 要关联的属性的value值。 |
...
...
@@ -641,7 +641,7 @@ DeleteProp(key: string): void
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ----
-- | ------ | --- | ---------
------------ |
| ----
| ------ | ---- |
------------ |
| key | string | 是 | 要取消的属性的key值。 |
```
ts
...
...
@@ -657,7 +657,7 @@ PersistProps(properties: {key: string, defaultValue: any}[]): void;
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 |
| ----
-- | ---------------------------------- | -- | ---------
--------- |
| ----
| ---------------------------------- | ---- |
--------- |
| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 |
```
ts
...
...
@@ -673,7 +673,7 @@ Keys(): Array\<string>
**返回值:**
| 类型 | 描述 |
| -------------
| -------------
------------- |
| -------------
- |
------------- |
| Array
\<
string> | 返回所有持久化属性的标记。 |
```
ts
...
...
@@ -705,20 +705,20 @@ EnvProp\<S>(key: string, value: S): boolean
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 |
| -----
- | ------ | --- | --------------- |
----------------- |
| -----
| ------ | ---- | ---------- | --------
----------------- |
| key | string | 是 | 要关联的key值 | 要关联的key值,支持的范围详见内置环境变量说明。 |
| value | S | 是 | 要关联的value值 | 要关联的value值。 |
**返回值:**
| 类型 | 描述 |
| ------- | ----------------------
------------
|
| ------- | ---------------------- |
| boolean | 返回该属性在AppStorage中是否存在。 |
**内置环境变量说明:**
| key | 类型 | 说明 |
| ------------
| ------------- |
------------------- |
| ------------
-------- | --------------- | ---------------------
------------------- |
| accessibilityEnabled | string | 无障碍屏幕朗读是否启用。 |
| colorMode | ColorMode | 深浅色模式,可选值为:
<br>
- ColorMode.LIGHT:浅色模式;
<br>
- ColorMode.DARK:深色模式。 |
| fontScale | number | 字体大小比例。 |
...
...
@@ -739,7 +739,7 @@ EnvProps(props: {key: string, defaultValue: any}[]): void
**参数:**
| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 |
| ----
-- | ---------------------------------- | --- | ------------------ | ---------
--------- |
| ----
| ---------------------------------- | ---- | --------- |
--------- |
| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 | 要关联的属性数组。 |
```
ts
...
...
@@ -755,7 +755,7 @@ Keys(): Array\<string>
**返回值:**
| 类型 | 描述 |
| -------------
| -----------
----------- |
| -------------
- |
----------- |
| Array
\<
string> | 返回关联的系统项数组。 |
```
ts
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录