Skip to content

Commit c8239e3

Browse files
committed
Add options_object documentation.
Signed-off-by: Kev Provance <kevin.provance@gmail.com>
1 parent 913f527 commit c8239e3

File tree

3 files changed

+27
-1
lines changed

3 files changed

+27
-1
lines changed
30.2 KB
Loading
Loading
+27-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
# Options Object
1+
# Options Object <Badge text="field, enhancement" type="warn"/>
2+
3+
The Options Object field is designed to give developers who use Redux a quick glance at
4+
their option values in a readable JSON string. Ideally, the field/enhancement is for
5+
develop purposes and doesn't need to be shipped in your final product.
6+
7+
<span style="display:block;text-align:center">![](./img/options_object.png)</span>
8+
9+
::: warning Table of Contents
10+
[[toc]]
11+
:::
12+
13+
##Usage
14+
This field is not set in the traditional Redux way by adding an option array to your config.
15+
Instead, it is an argument set in the [global arguments](../configuration/global_arguments.md) array.
16+
17+
The `options_object` is enabled by default and the field will automatically appear on your options screen.
18+
To disable it, simply add the following line inside the global arguments array:
19+
20+
```php
21+
'options_object' => false,
22+
```
23+
## Console Log
24+
For added conveinence, one may also display the current options object via the developer's
25+
console log (CTRL+SHIFT+I) by clicking the "Show OPbject in JavaScript Console Object" button.
26+
27+
<span style="display:block;text-align:center">![](./img/options_object_console.png)</span>

0 commit comments

Comments
 (0)