Vue Storefront Contentful

# Api Reference

# useContent

Provides full handling for CMS data fetching.

const { content, search, loading, error } = useContent(id)

# content

Storing fetched data from CMS.

  • Type: Array
  • Default: []

Fetching data from CMS.

  • Type: Function
  • Arguments:
    • url: Page URL slug
      • Type: String
    • type: Content type name
      • Type: String
      • Example: page
      • Default: page
    • id - Entry ID (use instead of url)
      • Type: String
    • locale - Locale (optional)
      • Type: String
      • Default: en
    • include - Include level of nested entries (optional)
      • Type: Number
      • Default: 3
    • custom - Custom search config (use instead of url or id, optional)
      • Type: CustomSearch
      • Default: {}
    • environment - Contentful enviroment
      • Type: String
      • Default: master
    • preview - Triggers fetching data from Contentful Preview API
      • Type: Boolean
      • Default: false
CustomSearch: {
  type: string // name of custom type
  field: string // name of field to search
  value: string // value of field to search
}

# loading

Data fetching loading indicator.

  • Type: Boolean
  • Default: false

# error

Data fetching error object.

  • Type: Object
  • Default: {}

# RenderContent

Will render the CMS data to the Vue.js components.

<render-content :content="content" />

# content

Passing fetched CMS data.

← Changelog →