Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created settings document for the Angular UI #5943

Merged
merged 3 commits into from
Oct 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 4 additions & 34 deletions docs/en/UI/Angular/Config-State.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,40 +93,6 @@ const searchUrl = this.config.getApiUrl("search");

This method returns the `url` of a specific API based on the key given as its only parameter. If there is no key, `'default'` is used.

### How to Get All Settings From the Store

You can use the `getSettings` method of `ConfigStateService` to get all of the settings object from the configuration state. Here is how you get all settings:

```js
// this.config is instance of ConfigStateService

const settings = this.config.getSettings();
```

In addition, the method lets you search settings by **passing a keyword** to it.

```js
const localizationSettings = this.config.getSettings("Localization");
/*
{
'Abp.Localization.DefaultLanguage': 'en'
}
*/
```

Beware though, **settings search is case sensitive**.

### How to Get a Specific Setting From the Store

You can use the `getSetting` method of `ConfigStateService` to get a specific setting from the configuration state. Here is an example:

```js
// this.config is instance of ConfigStateService

const defaultLang = this.config.getSetting("Abp.Localization.DefaultLanguage");
// 'en'
```

### How to Get a Specific Feature From the Store

You can use the `getFeature` method of `ConfigStateService` to get a specific feature from the configuration state. Here is an example:
Expand Down Expand Up @@ -231,6 +197,10 @@ Note that **you do not have to call this method at application initiation**, bec

Please refer to `Config.Environment` type for all the properties you can pass to `dispatchSetEnvironment` as parameter. It can be found in the [config.ts file](https://github.com/abpframework/abp/blob/dev/npm/ng-packs/packages/core/src/lib/models/config.ts#L13).

## See Also

- [Settings](./Settings.md)

## What's Next?

- [HTTP Requests](./Http-Requests)
2 changes: 1 addition & 1 deletion docs/en/UI/Angular/Localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,4 +237,4 @@ import(

## What's Next?

* [Permission Management](./Permission-Management.md)
* [Settings](./Settings.md)
60 changes: 58 additions & 2 deletions docs/en/UI/Angular/Settings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,59 @@
# Angular UI: Settings
# Settings

> This document explains how to get setting values in an Angular application. See the [settings document](../../Settings.md) to learn the setting system.
You can get settings on the client-side using the [config state service](./Config-State.md) if they are allowed by their setting definition on the server-side.

> This document only explains how settings work in the Angular UI projects. See the [settings document](../../../Settings.md) to understand the ABP setting system.

## Before Use

To use the `ConfigStateService`, you must inject it in your class as a dependency. You do not have to provide the service explicitly, because it is already **provided in root**.

```js
import { ConfigStateService } from '@abp/ng.core';

@Component({
/* class metadata here */
})
class DemoComponent {
constructor(private config: ConfigStateService) {}
}
```

## How to Get a Specific Setting

You can use the `getSetting` method of `ConfigStateService` to get a specific setting from the configuration state. Here is an example:

```js
// this.config is instance of ConfigStateService

const defaultLang = this.config.getSetting("Abp.Localization.DefaultLanguage");
// 'en'
```

### How to Get All Settings From the Store

You can use the `getSettings` method of `ConfigStateService` to obtain all settings as an object where the object properties are setting names and property values are setting values.

```js
// this.config is instance of ConfigStateService

const settings = this.config.getSettings();
// all settings as a key value pair
```

Additionally, the method lets you search settings by **passing a keyword** to it.

```js
const localizationSettings = this.config.getSettings("Localization");
/*
{
'Abp.Localization.DefaultLanguage': 'en'
}
*/
```

Beware though, **settings search is case-sensitive**.

## What's Next?

- [Permission Management](./Permission-Management.md)
4 changes: 4 additions & 0 deletions docs/en/docs-nav.json
Original file line number Diff line number Diff line change
Expand Up @@ -584,6 +584,10 @@
"text": "Localization",
"path": "UI/Angular/Localization.md"
},
{
"text": "Settings",
"path": "UI/Angular/Settings.md"
},
{
"text": "Permission Management",
"path": "UI/Angular/Permission-Management.md"
Expand Down