Vuex Actions
Modules
component-datadecoratorsdeep-linkingdrawersformslayout-statelistsnavpage-datapage-statepreloadertoolbarundovalidators
Functions
isPageSpecific(uri, store) ⇒ boolean
is uri page spectific
component-data
static
.triggerModelSave(uri, data) ⇒
promise
.triggerModelRender(store, uri, data) ⇒
promise
.removeComponent(store, data) ⇒
Promise
.removeHeadComponent(store, startNode) ⇒
Promise
inner
~findIndex(data, [uri]) ⇒
number
component-data.updateSchemaProp(store, schemaName, inputName, prop, value)
update a property value on a component schema
Kind: static method of component-data
Return{promise}:
Param | Type |
store |
|
schemaName |
|
inputName |
|
prop |
|
value |
|
component-data.triggerModelSave(uri, data) ⇒ promise
promise
trigger a the model.save of a component
Kind: static method of component-data
Param | Type |
uri |
|
data |
|
component-data.triggerModelRender(store, uri, data) ⇒ promise
promise
trigger a the model.render of a component
Kind: static method of component-data
Param | Type |
store |
|
uri |
|
data |
|
component-data.saveComponent(store, uri, data, [eventID], [snapshot], [prevData], forceSave) ⇒ Promise
Promise
save a component's data and re-render
Kind: static method of component-data
Param | Type | Description |
store |
| |
uri |
| |
data |
| (may be a subset of the data) |
[eventID] |
| when saving from a pubsub subscription |
[snapshot] |
| set to false if save is triggered by undo/redo |
[prevData] |
| manually passed in when undoing/redoing (because the store has already been updated) |
forceSave |
| if true, component will be saved even if it doesn't appear to have changed |
component-data.removeComponent(store, data) ⇒ Promise
Promise
remove a component from its parent note: removes from parent component OR page
Kind: static method of component-data
Param | Type | Description | ||
store |
| |||
data |
| el | {el, msg} where el is the component to delete |
component-data.removeHeadComponent(store, startNode) ⇒ Promise
Promise
remove head components (from page or layout)
Kind: static method of component-data
Param | Type | Description |
store |
| |
startNode |
| comment with data-uri |
component-data.addCreatedComponentsToPageArea(store, newComponents, currentURI, path, replace, number, array, boolean) ⇒ Promise
Promise
add components to a page area
Kind: static method of component-data
Param | Type |
store |
|
newComponents |
|
currentURI |
|
path |
|
replace |
|
number |
|
array |
|
boolean |
|
component-data.addComponents(store, [currentURI], parentURI, path, [replace], components) ⇒ Promise
Promise
add components to a parent component (or page) note: allows multiple components to be added at once note: always creates new instances of the components you're adding note: allows you to replace a specific uri, or add components after it note: if no currentURI passed in, it will add new components to the end (and won't replace anything)
Kind: static method of component-data
Returns: Promise
- with the last added component's el
Param | Type | Description |
store |
| |
[currentURI] |
| if adding after / replacing a specific component |
parentURI |
| |
path |
| |
[replace] |
| to replace the current URI |
components |
| to add (object with name and [data]) |
component-data.openAddComponent(store, [currentURI], parentURI, path) ⇒ Promise
Promise
open the add components pane, or add a new components
Kind: static method of component-data
Param | Type | Description |
store |
| |
[currentURI] |
| if we're inserting after a specific component |
parentURI |
| |
path |
|
component-data.componentAdded(store, componentName, uri)
Store the last item added
Kind: static method of component-data
Param | Type |
store |
|
componentName |
|
uri |
|
component-data.closeAddComponent(store)
Close the add component
Kind: static method of component-data
Param | Type |
store |
|
component-data.currentlyRestoring(store, restoring)
open the add components pane, or add a new components
Kind: static method of component-data
Param | Type | Description |
store |
| |
restoring |
| if we're currently restoring a page |
component-data~logSaveError(uri, e, data, [eventID], [snapshot], store)
log errors when components save and display them to the user
Kind: inner method of component-data
Param | Type |
uri |
|
e |
|
data |
|
[eventID] |
|
[snapshot] |
|
store |
|
component-data~revertReject(uri, data, [snapshot], paths, store) ⇒ Promise
Promise
re-render (reverting) a component and stop the saving promise chain
Kind: inner method of component-data
Param | Type |
uri |
|
data |
|
[snapshot] |
|
paths |
|
store |
|
component-data~clientSave(uri, data, oldData, store, [eventID], [snapshot], paths) ⇒ Promise
Promise
save data client-side and queue up api call for the server note: this uses the components' model.js (if it exists) and handlebars template note: server-side saving and/or re-rendering has been removed in kiln v4.x
Kind: inner method of component-data
Param | Type | Description |
uri |
| |
data |
| |
oldData |
| |
store |
| |
[eventID] |
| |
[snapshot] |
| passed through to render |
paths |
|
component-data~findIndex(data, [uri]) ⇒ number
number
find the index of a uri in a list this is broken out into a separate function so we don't assume an index of 0 is falsy
Kind: inner method of component-data
Param | Type |
data |
|
[uri] |
|
component-data~addComponentsToComponentList(store, data, [currentURI], parentURI, path, [replace], components) ⇒ Promise
Promise
add one or more components to a component list
Kind: inner method of component-data
Param | Type | Description |
store |
| |
data |
| list data |
[currentURI] |
| if you want to add after / replace a specific current component |
parentURI |
| |
path |
| of the list |
[replace] |
| to replace currentURI |
components |
| with { name, [data] } |
component-data~addComponentsToComponentProp(store, data, parentURI, path, components) ⇒ Promise
Promise
replace a single component in another component's property
Kind: inner method of component-data
Param | Type | Description |
store |
| |
data |
| |
parentURI |
| |
path |
| |
components |
| note: it'll only replace using the first thing in this array |
component-data~addComponentsToPageArea(store, currentURI, path, replace, components) ⇒ Promise
Promise
create components to be added to a page area (i.e. head, main, etc.)
Kind: inner method of component-data
Param | Type |
store |
|
currentURI |
|
path |
|
replace |
|
components |
|
decorators
decorators.unselect(store)
unselect currently-selected component
Kind: static method of decorators
Param | Type |
store |
|
decorators.select(store, el)
select a component
Kind: static method of decorators
Param | Type |
store |
|
el |
|
decorators.scrollToComponent(store, el)
Scroll user to the component. "Weeee!" or "What the?"
Kind: static method of decorators
Param | Type |
store |
|
el |
|
decorators.navigateComponents(store, direction) ⇒ Promise
Promise
navigate to the previous or next component
Kind: static method of decorators
Param | Type | Description |
store |
| |
direction |
| 'prev' or 'next' |
decorators.unfocus(store) ⇒ Promise
Promise
unfocus currently-focused field/group
Kind: static method of decorators
Param | Type |
store |
|
deep-linking
deep-linking.parseURLHash(store) ⇒ Promise
Promise
parse url hash, opening form or clay menu as necessary
Kind: static method of deep-linking
Param | Type |
store |
|
deep-linking.setHash(commit, [uri], [path], [initialFocus], [menu])
set hash in window and store
Kind: static method of deep-linking
Param | Type |
commit |
|
[uri] |
|
[path] |
|
[initialFocus] |
|
[menu] |
|
deep-linking.clearHash(commit)
clear hash in window and store
Kind: static method of deep-linking
Param | Type |
commit |
|
drawers
drawers.closeDrawer(store)
close drawer without toggling a new drawer
Kind: static method of drawers
Param | Type |
store |
|
drawers.openDrawer(store, nameOrConfig)
open drawer
Kind: static method of drawers
Param | Type | Description |
store |
| |
nameOrConfig |
| either just the tab name or a json object for deeper linking |
forms
forms.updateFormData(store, path, val)
Update form data
Kind: static method of forms
Param | Type |
store |
|
path |
|
val |
|
forms.openForm(store, uri, path, [el], [offset], [appendText], [initialFocus], pos)
open form
Kind: static method of forms
Param | Type | Description |
store |
| |
uri |
| component uri |
path |
| field/form path |
[el] |
| parent element (for inline forms) |
[offset] |
| caret offset (for text inputs) |
[appendText] |
| text to append (for text inputs, used when splitting/merging components with text fields) |
[initialFocus] |
| if focusing on a specific field when opening the form |
pos |
| x/y coordinates used to position overlay forms |
forms.closeForm(store) ⇒ promise
promise
Close a form
Kind: static method of forms
Param | Type |
store |
|
forms~hasDataChanged(newData, oldData) ⇒ Boolean
Boolean
determine if data in form has changed note: convert data to plain objects, since they're reactive
Kind: inner method of forms
Param | Type | Description |
newData |
| from form |
oldData |
| from store |
layout-state
.scheduleLayout(store, timestamp) ⇒
Promise
.unscheduleLayout(store, [publishing]) ⇒
Promise
.publishLayout(store) ⇒
Promise
layout-state.fetchLayoutState(store, [preloadOptions]) ⇒ Promise
Promise
get the list data for a specific layout note: if prefix / uri is specified, this does NOT commit the data (only returns it), allowing the preloader to use it when doing the initial preload of data
Kind: static method of layout-state
Param | Type |
store |
|
[preloadOptions] |
|
[preloadOptions.uri] |
|
[preloadOptions.prefix] |
|
[preloadOptions.user] |
|
layout-state.updateLayout(store, [data], [preloadOptions]) ⇒ Promise
Promise
update a layout's title, or just the latest timestamp + user
Kind: static method of layout-state
Param | Type |
store |
|
[data] |
|
[data.title] |
|
[preloadOptions] |
|
layout-state.scheduleLayout(store, timestamp) ⇒ Promise
Promise
schedule the layout and update its index
Kind: static method of layout-state
Param | Type |
store |
|
timestamp |
|
layout-state.unscheduleLayout(store, [publishing]) ⇒ Promise
Promise
unschedule the layout get updated layout state if the call wasn't made during layout publish
Kind: static method of layout-state
Param | Type |
store |
|
[publishing] |
|
layout-state.publishLayout(store) ⇒ Promise
Promise
publish layout note: layouts index is updated server-side, including unscheduling the layout if it's currently scheduled also note: this will trigger a fetch of the updated (published) layout state
Kind: static method of layout-state
Param | Type |
store |
|
lists
nav
nav.openNav(store, nameOrConfig)
open nav tab
Kind: static method of nav
Param | Type | Description |
store |
| |
nameOrConfig |
| tab name, or clay menu config openNav sets the ui.currentDrawer vuex variable, this allows drawers (the right slide-in menus) as well as the "nav" (the left slide-in menu) to be deep linked to. The openNav/closeNav are functions are depreciated. Should use the openDrawer/closeDrawer/toggleDrawer actions Just leaving these here in case any legacy plugins are still calling these functions |
page-data
static
.savePage(store, data, [snapshot]) ⇒
Promise
.createPage(store, id) ⇒
Promise
.publishPage(store, uri) ⇒
Promise
.unpublishPage(store, uri) ⇒
Promise
.schedulePage(store, uri, timestamp) ⇒
Promise
.unschedulePage(store, [publishing]) ⇒
Promise
inner
~shouldRender(paths) ⇒
boolean
~removeURI(uri, store) ⇒
Promise
page-data.savePage(store, data, [snapshot]) ⇒ Promise
Promise
save a page's data, but do not re-render because, uh, that would just be reloading the page
Kind: static method of page-data
Param | Type | Description |
store |
| |
data |
| to save |
[snapshot] |
| false if we're undoing/redoing |
page-data.createPage(store, id) ⇒ Promise
Promise
create a new page, then return its editable link
Kind: static method of page-data
Param | Type |
store |
|
id |
|
page-data.isPublishing(store, isPublishing)
set currentlyPublishing in state
Kind: static method of page-data
Param | Type |
store |
|
isPublishing |
|
page-data.publishPage(store, uri) ⇒ Promise
Promise
manually publish the page
Kind: static method of page-data
Param | Type |
store |
|
uri |
|
page-data.unpublishPage(store, uri) ⇒ Promise
Promise
remove uri from /uris/
Kind: static method of page-data
Param | Type |
store |
|
uri |
|
page-data.schedulePage(store, uri, timestamp) ⇒ Promise
Promise
schedule the page to publish
Kind: static method of page-data
Param | Type |
store |
|
uri |
|
timestamp |
|
page-data.unschedulePage(store, [publishing]) ⇒ Promise
Promise
unschedule the page get updated page state if the call wasn't made during a page publish
Kind: static method of page-data
Param | Type |
store |
|
[publishing] |
|
page-data~shouldRender(paths) ⇒ boolean
boolean
iterate through the paths we're saving if one of them ISN'T in the internalPageProps, we should re-render
Kind: inner method of page-data
Param | Type |
paths |
|
page-data~removeURI(uri, store) ⇒ Promise
Promise
remove uri from /uris/
Kind: inner method of page-data
Param | Type |
uri |
|
store |
|
page-state
static
.updatePageList(store, [data]) ⇒
Promise
.getListData(store, uri, [prefix]) ⇒
Promise
inner
~sequentialUpdate(prefix, uri, data) ⇒
Promise
page-state.updatePageList(store, [data]) ⇒ Promise
Promise
update page list with data provided from pubsub note: if called without data, this just updates the updateTime and user (e.g. when saving components in the page) note: if called with a user, it adds the user (with updateTime) to the page (instead of current user)
Kind: static method of page-state
Param | Type |
store |
|
[data] |
|
page-state.getListData(store, uri, [prefix]) ⇒ Promise
Promise
get the list data for a specific page note: if prefix is specified, this does NOT commit the data (only returns it), allowing the preloader to use it when doing the initial preload of data
Kind: static method of page-state
Param | Type | Description |
store |
| |
uri |
| |
[prefix] |
| passed in when preloading (e.g. if site isn't in store yet) |
page-state~sequentialUpdate(prefix, uri, data) ⇒ Promise
Promise
run page list updates sequentially, grabbing from the store after each to prevent race conditions
Kind: inner method of page-state
Param | Type |
prefix |
|
uri |
|
data |
|
preloader
~getComponentModels() ⇒
object
~getComponentKilnjs() ⇒
object
~getPageStatus(state) ⇒
string
~getSchemas(schemas, kilnjs) ⇒
object
preloader~getComponentModels() ⇒ object
object
get component models so we can mount them on window.kiln.componentModels if they aren't already mounted (backwards-compatability)
Kind: inner method of preloader
preloader~getComponentKilnjs() ⇒ object
object
get component kiln files so we can mount them on window.kiln.componentKilnjs
Kind: inner method of preloader
preloader~reduceComponents(result, val) ⇒ obj
obj
extract component data from preloadData obj
Kind: inner method of preloader
Param | Type |
result |
|
val |
|
preloader~composeLayoutData(layoutSchema, components, original) ⇒ object
object
extract layout data from original data
Kind: inner method of preloader
Param | Type | Description |
layoutSchema |
| schema for layout |
components |
| key/value store of components |
original |
| original preloaded data |
preloader~reduceTemplates(result, val, key) ⇒ obj
obj
make precompiled hbs templates ready for user
Kind: inner method of preloader
Param | Type |
result |
|
val |
|
key |
|
preloader~getPageStatus(state) ⇒ string
string
get string state to pass to progress bar
Kind: inner method of preloader
Param | Type |
state |
|
preloader~getSchemas(schemas, kilnjs) ⇒ object
object
run a copy of the schema through its kiln.js file (if it has one)
Kind: inner method of preloader
Param | Type |
schemas |
|
kilnjs |
|
toolbar
toolbar.startProgress(commit, type)
start progress bar. if already started, this will cause a slight pause before continuing the progress bar
Kind: static method of toolbar
Param | Type | Description |
commit |
| |
type |
| e.g. 'save' or 'publish' |
toolbar.finishProgress(commit, type)
finish the progress bar.
Kind: static method of toolbar
Param | Type | Description |
commit |
| |
type |
| e.g. 'save' or 'publish' |
toolbar.addAlert(store, config)
add alert to the array
Kind: static method of toolbar
Param | Type | Description |
store |
| |
config |
| the text of the alert (for info), or an object with { type, text } |
toolbar.removeAlert(store, config)
remove an alert from the array, specifying the index
Kind: static method of toolbar
Param | Type | Description |
store |
| |
config |
| index or an equivalent config object |
toolbar.showSnackbar(store, config)
trigger a new snackbar. note: this happens imperatively (toolbar handles the actual creation, by watching this value) note: if you want the snackbar to have an action, pass in both action
(the text of the button) and onActionClick
(a reference to the function you want invoked)
Kind: static method of toolbar
Param | Type | Description |
store |
| |
config |
| message or full config object |
undo
undo.createSnapshot(store)
create snapshot. called from the plugin listening to batched renders
Kind: static method of undo
Param | Type |
store |
|
undo.setFixedPoint(store)
"You're a fixed point in time and space. You're a fact. That's never meant to happen." when doing a manual save from some point in history, we need to remove snapshots after that point (to preserve the expected undo functionality)
Kind: static method of undo
Param | Type |
store |
|
undo.undo(store)
undo: sets cursor back one, re-saves affected components with old data
Kind: static method of undo
Param | Type |
store |
|
undo.redo(store)
redo: sets cursor forward one, re-saves affected components with new data
Kind: static method of undo
Param | Type |
store |
|
undo~getChangedComponents(current, compare) ⇒ object
object
get changed components, used by undo and redo
Kind: inner method of undo
Param | Type | Description |
current |
| |
compare |
| (prev/next components object) |
undo~saveChangedComponents(changedComponents, store)
render multiple components at once
Kind: inner method of undo
Param | Type |
changedComponents |
|
store |
|
validators
static
.runMetaValidator(metadata) ⇒
function
.isMetadataError(scope, type) ⇒
boolean
.isMetadataWarning(scope, type) ⇒
boolean
.isGlobalMetadataError(validator) ⇒
boolean
.isGlobalMetadataWarning(validator) ⇒
boolean
.validate(store) ⇒
Promise
inner
~isComponentInPageHeadList(uri, state) ⇒
Boolean
~runValidator(state) ⇒
function
~runValidators(validators, state) ⇒
Promise
~hasItems(error) ⇒
Boolean
validators.runMetaValidator(metadata) ⇒ function
function
run an metadata validator. if it returns items, add the label and description and items
Kind: static method of validators
Param | Type |
metadata |
|
validators.runMetaValidators(uri, errorValidators, warningValidators) ⇒ Promise
Promise
run a list of validators using page metadata
Kind: static method of validators
Param | Type | Description |
uri |
| page uri |
errorValidators |
| validators for errors |
warningValidators |
| validators for warnings |
validators.runKilnjsValidators(schemas, components) ⇒ array
array
Run the kilnjsValidators
Kind: static method of validators
Param | Type |
schemas |
|
components |
|
validators.getSchemasWithValidationRules(schemas) ⇒ object
object
Get the schemas that have a validation property
Kind: static method of validators
Param | Type |
schemas |
|
validators.isMetadataError(scope, type) ⇒ boolean
boolean
Check whether is a metadata error
Kind: static method of validators
Param | Type |
scope |
|
type |
|
validators.isMetadataWarning(scope, type) ⇒ boolean
boolean
Check whether is a metadata warning
Kind: static method of validators
Param | Type |
scope |
|
type |
|
validators.isGlobalMetadataError(validator) ⇒ boolean
boolean
Check whether is a metadata error
Kind: static method of validators
Param | Type |
validator |
|
validator.scope |
|
validator.type |
|
validator.uri |
|
validators.isGlobalMetadataWarning(validator) ⇒ boolean
boolean
Check whether is a metadata error
Kind: static method of validators
Param | Type |
validator |
|
validator.scope |
|
validator.type |
|
validator.uri |
|
validators.isSpecificMetadataWarning(validator, pageUri) ⇒ boolean
boolean
Check whether is a metadata warning for specific page
Kind: static method of validators
Param | Type |
validator |
|
validator.scope |
|
validator.type |
|
validator.uri |
|
pageUri |
|
validators.isSpecificMetadataError(validator, pageUri) ⇒ boolean
boolean
Check whether is a metadata error for specific page
Kind: static method of validators
Param | Type |
validator |
|
validator.scope |
|
validator.type |
|
validator.uri |
|
pageUri |
|
validators.validate(store) ⇒ Promise
Promise
trigger validation
Kind: static method of validators
Param | Type |
store |
|
validators~isComponentInPageHeadList(uri, state) ⇒ Boolean
Boolean
determine if a component is in a page-specific head list
Kind: inner method of validators
Param | Type |
uri |
|
state |
|
validators~runValidator(state) ⇒ function
function
run an individual validator. if it returns items, add the label and description
Kind: inner method of validators
Param | Type |
state |
|
validators~runValidators(validators, state) ⇒ Promise
Promise
run a list of validators
Kind: inner method of validators
Param | Type |
validators |
|
state |
|
validators~hasItems(error) ⇒ Boolean
Boolean
make sure that all errors have items that can display. some may have been parsed out by the isActive check in runValidator, above
Kind: inner method of validators
Param | Type |
error |
|
validators~validKilnjsValidator(validators, validationRule) ⇒ boolean
boolean
Check if the validationRule has the correct properties to run validation with
Kind: inner method of validators
Param | Type |
validators |
|
validationRule |
|
validators~getKilnJsFieldAndValue(validationRule, component) ⇒ object
object
Get the inputs from a validationRule, either as a string or as an array the fieldName is the name of the input that will have the focus when the user clicks to that error from the Health Tab the value is what will be tested by the rule
Kind: inner method of validators
Param | Type |
validationRule |
|
component |
|
validators~getKilnJsError(validationError, errorItem, errors) ⇒ array
array
Add error to Errors, either as a completely new error, or as an entry in an existing error
Kind: inner method of validators
Param | Type |
validationError |
|
errorItem |
|
errors |
|
isPageSpecific(uri, store) ⇒ boolean
boolean
is uri page spectific
Kind: global function
Param | Type |
uri |
|
store |
|
Last updated