Settings

You can get settings on the client-side using the config state service 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 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.

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:

// 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.

// 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.

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

Beware though, settings search is case-sensitive.

Contributors


Last updated: November 06, 2020 Edit this page on GitHub

Was this page helpful?

Please make a selection.

To help us improve, please share your reason for the negative feedback in the field below.

Please enter a note.

Thank you for your valuable feedback!

Please note that although we cannot respond to feedback, our team will use your comments to improve the experience.

In this document
Community Talks

Building Modular Monolith Applications Using .NET and ABP Framework

17 Oct, 17:00
Online
Register Now
Mastering ABP Framework Book
Mastering ABP Framework

This book will help you gain a complete understanding of the framework and modern web application development techniques.

Learn More