提交 540f787a 编写于 作者: H HelloCrease

update docs

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 68a9effd
# 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#属性)。
## 事件
不支持通用事件。
......
......@@ -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.
先完成此消息的编辑!
想要评论请 注册