UNPKG

ohayolibs

Version:

Ohayo is a set of essential modules for ohayojp.

49 lines (36 loc) • 2.75 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
--- order: 1 title: SettingsService subtitle: Project configuration type: Service --- Project config data, includes [App](https://github.com/ohayojp/ohayo/blob/master/packages/theme/src/services/settings/interface.ts#L1), [Layout](https://github.com/ohayojp/ohayo/blob/master/packages/theme/src/services/settings/interface.ts#L15), [User](https://github.com/ohayojp/ohayo/blob/master/packages/theme/src/services/settings/interface.ts#L8), three data types And store persistence in `localStorage` (Please refer to [#1737](https://github.com/ohayojp/ohayojp/issues/1737) to switch to `sessionStorage`). **Suggest:** Call the `setApp()`, `setUser()` methods to restore project config data, via Angular startup service ([startup.service.ts](https://github.com/ohayojp/ohayojp/blob/master/src/app/core/startup/startup.service.ts)). ## API ### SettingsService | Name | Type | Return Value | Description | | ------------------------------------- | ---------- | ---------------------------- | -------------- | | `layout` | `property` | `Layout` | Data of layout | | `app` | `property` | `App` | Data of app | | `user` | `property` | `User` | Data of User | | `notify` | `property` | `Observable<SettingsNotify>` | Changed notification | | `setLayout(name: string, value: any)` | `method` | `boolean` | Set property value of layout | | `setApp(value: App)` | `method` | `boolean` | Set app data | | `setUser(value: User)` | `method` | `boolean` | Set user data | ### App | Property | Description | Type | Default | |-----------------|---------------------|----------|---------| | `[name]` | Name for app | `string` | - | | `[description]` | Description for app | `string` | - | ### User | Property | Description | Type | Default | |------------|-------------------------|----------|---------| | `[name]` | Name for current user | `string` | - | | `[avatar]` | Avatar for current user | `string` | - | | `[email]` | Email for current user | `string` | - | ### Layout | Property | Description | Type | Default | |---------------|----------------------|-----------|---------| | `[collapsed]` | Whether to fold menu | `boolean` | - | | `[lang]` | Current language | `string` | - | | `[colorWeak]` | Color weak | `boolean` | `false` |