Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/alex-oleshkevich/vue-config

A static config plugin.
https://github.com/alex-oleshkevich/vue-config

Last synced: about 2 months ago
JSON representation

A static config plugin.

Lists

README 

        
# vue-configuration

A static config plugin.



## Installation

### Add package

```bash

yarn add vue-configuration



# or via npm:

npm i vue-configuration

```



### Install plugin

```javascript

import Vue from 'vue';

import VueConfig from 'vue-configuration';

import appConfig from './config.js';



// pass config object to the plugin

Vue.use(VueConfig, {

    config: appConfig

});

```



### Usage

Access config values in any part of app using simple API:



```javascript

this.$config.get('node');

```



Use dot-notation for keys:

```javascript

this.$config.get('node.child.leaf');

```



Default values if value not set:

```javascript

this.$config.get('node.child.leaf.empty', 'default');

```



Replace config:

```javascript

this.$config.replace({ new: 'data' });

```



Test if path exists:

```javascript

// obj = { a: 1 }

this.$config.has('a.b.c'); // false

this.$config.has('a'); // true

```



Get config object:

```javascript

this.$config.all();

```



### Example

`config.js`

```javascript

export default {

    facebook: {

        apiToken: 'abc',

        clientSecret: 'topsecret'

    },

    allowRegistration: true

};

```



Get node:

```javascript

this.$config.get('facebook');

// { apiToken: 'abc', clientSecret: 'topsecret' }

```



Read Facebook's API token in component:

```javascript

this.$config.get('facebook.apiToken');

// 'abc'

```



Test if registration is open:

```javascript

this.$config.get('allowRegistration');

// true

```



Test if login is available:

```javascript

this.$config.get('allowLogin', false);

// oops, not defined! return "false" as default

```