DruxtMenuStore

DruxtMenuStore

Vuex module, registered under the druxtMenu namespace. The druxtMenu Vuex module.

Provides a Vuex state object, mutations, actions and getters for interacting Drupal JSON:API Menu Items.

See: The DruxtStore

• druxtMenu
  • action
    • get(vuexContext, context)
  • mutation
    • addEntities
    • flushEntities
  • getEntitiesByFilter ⇒ function

get(vuexContext, context)

Get menu by name.

• Fetches the menu items from the JSON:API endpoint.
• Commits the menu items to the Vuex state object.
  Vuex Action => Mutates state propertyentities

Kind: action method of druxtMenu

Example

await this.$store.dispatch('druxtMenu/get', { name: 'main' })

addEntities

Adds specified Drupal JSON:API Menu Items data to the Vuex state object.

Kind: mutation method of druxtMenu

Example

this.$store.commit('druxtMenu/addEntities', { entities, prefix })

flushEntities

Removes JSON:API menu item entities from the Vuex state object.

Kind: mutation method of druxtMenu

Example

// Flush all menu entities.
this.$store.commit('druxtMenu/flushEntities', {})

getEntitiesByFilter ⇒ function

Get entities by filter.

Returns: function - Filter function; takes { filter, prefix } where filter is a filter() method compatible function.

Example

const items = this.$store.getters.getEntitiesByFilter(key => {
  return this.entities[key].attributes.menu_name === 'main'
})

State : object

The Vuex State object.

Kind: global typedef
Properties

addEntitiesPayload : object

Parameters for the addEntities mutation.

Kind: global typedef

Example

{
  entities: [{}],
  prefix: 'en'
}

flushEntitiesPayload : object

Parameters for the flushEntities mutation.

Kind: global typedef

Example

{
  prefix: 'en'
}