reagent-dev-tools.core

Liking cljdoc? Tell your friends :D

ClojureScript only.

collection-info-handler
create-default-panels
default-toggle-btn
dev-tool
element-id
register-collection-info-handler!
start!
state-tree

collection-info-handler^cljs

create-default-panels^cljs

(create-default-panels options)

default-toggle-btn^cljs

(default-toggle-btn open-fn)

dev-tool^cljs

(dev-tool {:keys [panels] :as options})

element-id^cljs

register-collection-info-handler!^cljs

start!^cljs

(start! opts)

Start Reagent dev tool.

Options:

:el (optional) The element to render the dev-tool into. If the property is given, but is nil, dev tool is not enabled. If not given, new div is created and used.
:margin-element (optional) Element where to set margin-bottom/right if the panel is open. This is helpful so that the dev tool isn't displayed over the application content.
:state-atom This options adds default state-tree panel displaying tree for the given RAtom.
:state-atom-name (optional) Overrides the name for default state-tree panel.
:panels List of panel maps to display. This is appended to the default panels, if you don't want to include default panels, leave out :state-atom option and define all panels here.
:toggle-btn (optional) Reagent component to render the open button. Takes open-fn as parameter. Rendered as functional component so the component can also use hooks.

Panel options:

:key (Required) React key
:label (Required) Label for tab bar
:view (Required) Reagent Hiccup form to display the panel content

Built-in panel component options:

reagent-dev-tools.core/state-tree
- :ratom (Required) The RAtom to display
- :label (Optional) Label to display for atom root node, will default to panel :label.

Start Reagent dev tool.

Options:

- `:el` (optional) The element to render the dev-tool into. If the property is given,
but is nil, dev tool is not enabled. If not given, new div is created and used.
- `:margin-element` (optional) Element where to set margin-bottom/right if the panel is open.
This is helpful so that the dev tool isn't displayed over the application content.
- `:state-atom` This options adds default `state-tree` panel displaying tree for the given RAtom.
- `:state-atom-name` (optional) Overrides the name for default `state-tree` panel.
- `:panels` List of panel maps to display. This is appended to the default panels, if you
don't want to include default panels, leave out :state-atom option and define all panels here.
- `:toggle-btn` (optional) Reagent component to render the open button. Takes `open-fn` as parameter.
Rendered as functional component so the component can also use hooks.

Panel options:
- `:key` (Required) React key
- `:label` (Required) Label for tab bar
- `:view` (Required) Reagent Hiccup form to display the panel content

Built-in panel component options:

- `reagent-dev-tools.core/state-tree`
    - `:ratom` (Required) The RAtom to display
    - `:label` (Optional) Label to display for atom root node, will default to panel :label.

raw docstring