Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lexascms/vsf-next-lexascms
Official LexasCMS module for Vue Storefront 2.x
https://github.com/lexascms/vsf-next-lexascms
ecommerce lexascms vsf-next vue-storefront vue-storefront-next vuejs vuestorefront vuestorefront-next
Last synced: 15 days ago
JSON representation
Official LexasCMS module for Vue Storefront 2.x
- Host: GitHub
- URL: https://github.com/lexascms/vsf-next-lexascms
- Owner: LexasCMS
- License: mit
- Created: 2020-11-16T11:55:02.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T17:41:55.000Z (11 months ago)
- Last Synced: 2024-05-22T16:33:19.953Z (6 months ago)
- Topics: ecommerce, lexascms, vsf-next, vue-storefront, vue-storefront-next, vuejs, vuestorefront, vuestorefront-next
- Language: TypeScript
- Homepage:
- Size: 1.75 MB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
This is the official Vue Storefront Next module for retrieving content from LexasCMS.
Installation •
How To Use •
Full Example •
License
Table of Contents
----------------------------------------------------------------
- [Installation](#installation)
- [How to Use](#how-to-use)
- [Fetching a collection](#fetching-a-collection)
- [Supported parameters](#supported-parameters)
- [Fetching a single item](#fetching-a-single-item)
- [Supported parameters](#supported-parameters-1)
- [Request Context](#request-context)
- [Supporting Content Previews](#supporting-content-previews)
- [Full Example](#full-example)
- [Tutorials](#tutorials)
- [License](#license)
Installation
----------------------------------------------------------------
Please follow the below instructions to install `vsf-lexascms` in your **Vue Storefront Next** project.
#### 1. Install the NPM package
Install the `vsf-lexascms` NPM package by running one of the following commands:
```bash
# Yarn
yarn add vsf-lexascms
# NPM
npm install vsf-lexascms
```
#### 2. Configure the module
Add the `vsf-lexascms` Nuxt module to the `buildModules` section of your projects `nuxt.config.js` file:
```js
export default {
// ...
buildModules: [
// ...
['vsf-lexascms/nuxt']
]
// ...
};
```
#### 3. Configure middleware
Open the `middleware.config.js` file in the root of your project and add the following configuration:
```js
module.exports = {
integrations: {
// ...
lexascms: {
location: 'vsf-lexascms/server',
configuration: {
spaceId: 'YOUR_SPACE_ID',
apiKey: 'YOUR_API_KEY' // Optional, unless using content previews
}
}
}
};
```
How To Use
----------------------------------------------------------------
Once you have installed the `vsf-lexascms` module, content can be retrieved using the `useContent` composable.
```ts
import { useContent } from 'vsf-lexascms';
const { search, content, loading, error } = useContent();
```
- `search` is a function and is used for retrieving content from LexasCMS.
- `content`, `loading` and `error` are all computed properties which are populated by the `search` method
- `content` contains the content retrieved by the search method
- `loading` is a boolean which communicates whether the `search` method is currently running or not
- `error` is null unless an error is thrown by the `search` method, in which case this contains the error message
### Fetching a collection
The following code snippet shows an example of how you could retrieve a collection of promo banners from LexasCMS.
```ts
import { useContent } from 'vsf-lexascms';
export default {
setup() {
const { search, content, loading, error } = useContent();
await search({
type: 'collection',
contentType: 'promoBanners'
// Optionally provide additional params, see supported parameters below
// params: {
//
// }
//
// Override the request context for this request, see the 'Request Context' section for more details
// context: {
//
// }
});
return { content, loading, error };
}
};
```
#### Supported parameters
As suggested in the code snippet above, you can also pass some additional parameters for making your queries more specific (e.g. filtering, localisation etc.).
| Name | Type | Required | Example | Comments |
|-------------|--------|----------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| fields | Object | N | `{ promoBanner: 'title,subtitle' }` | See [sparse fieldsets documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/sparse-fieldsets/) for more info. |
| filter | Object | N | `{ title: { _startsWith: 'Hello' } }` | See [filtering documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/filtering/) for more info. |
| include | String | N | `backgroundImage` | See [fetching records documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/fetching-records/#including-related-records) for more info. |
| localeCode | String | N | `en-GB` | See [localisation documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/localisation/) for more info. |
| page | Object | N | `{ limit: 2, skip: 4 }` | See [pagination documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/pagination/) for more info. |
| sort | String | N | `title` | See [ordering documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/ordering/) for more info. |
### Fetching a single item
The following code snippet shows an example of how you could retrieve an individual promo banner from LexasCMS.
```ts
import { useContent } from 'vsf-lexascms';
export default {
setup() {
const { search, content, loading, error } = useContent();
await search({
type: 'item',
contentType: 'promoBanner',
itemId: 'example-promo-banner-id'
// Optionally provide additional params, see supported parameters below
// params: {
//
// }
//
// Override the request context for this request, see the 'Request Context' section for more details
// context: {
//
// }
});
return { content, loading, error };
}
};
```
#### Supported parameters
As suggested in the code snippet above, you can also pass some additional parameters for making your queries more specific (e.g. localisation, pagination etc.).
| Name | Type | Required | Example | Comments |
|-------------|--------|----------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| fields | Object | N | `{ promoBanner: 'title,subtitle' }` | See [sparse fieldsets documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/sparse-fieldsets/) for more info. |
| include | String | N | `backgroundImage` | See [fetching records documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/fetching-records/#including-related-records) for more info. |
| localeCode | String | N | `en-GB` | See [localisation documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/localisation/) for more info. |
| page | Object | N | `{ relationshipField: { limit: 2, skip: 4 } }` | See [pagination documentation](https://www.lexascms.com/docs/api-reference/content-delivery/jsonapi/pagination/) for more info. |
### Request Context
In the event that you would like to provide a request context with your requests to LexasCMS (i.e. for content personalisation), you can pass the `context` property to the `search` function.
The following snippet shows an example of setting the request context:
```ts
import { useContent } from 'vsf-lexascms';
export default {
setup() {
const { search, content, loading, error } = useContent();
await search({
type: 'collection',
contentType: 'promoBanner',
context: {
audienceAttributes: {
age: 25,
location: 'GB'
}
}
});
return { content, loading, error };
}
};
```
### Supporting Content Previews
When making use of LexasCMS's [visual content previews](https://www.lexascms.com/features/content-previews/) feature, LexasCMS will load your website with the `lexascmsRequestContent` query parameter.
The value of this parameter will be a pre-encoded request context, which should be provided directly to all requests to the Content Delivery API.
The following snippet shows an example of how this could be achieved:
```ts
import { useContent } from 'vsf-lexascms';
export default {
setup(_, context) {
const { search, content, loading, error } = useContent();
await search({
type: 'collection',
contentType: 'promoBanner',
context: context.root.$route.query.lexascmsRequestContext ?? null
});
return { content, loading, error };
}
};
```
Full Example
----------------------------------------------------------------
The below code shows a full example of how you could create a small component which lists the available promo banners:
```vue
Loading promo banners...
Error loading promo banners!
-
{{ promoBanner.title }}
import { useContent } from 'vsf-lexascms';
import { onSSR } from '@vue-storefront/core';
export default {
name: 'PromoBanners',
setup() {
// useContent
const { search, content, loading, error } = useContent();
// Retrieve promo banners on server-side render only
onSSR(async () => {
await search({
type: 'collection',
contentType: 'promoBanner'
});
});
// Return
return {
promoBanners: content,
loading,
error
};
}
};
```
Tutorials
----------------------------------------------------------------
Prefer a more guided tutorial? Check out our 3 part tutorial series using the links below:
- [Part 1 - Headless CMS Integration](https://www.lexascms.com/blog/integrating-a-headless-cms-with-vue-storefront-next/)
- [Part 2 - Personalised Content](https://www.lexascms.com/blog/implementing-personalised-content-with-vue-storefront-next/)
- [Part 3 - Visual Content Previews](https://www.lexascms.com/blog/visual-content-previews-with-vue-storefront-next/)
License
----------------------------------------------------------------
This project is licensed under the [MIT License](LICENSE).