@cxco/ui-seo

SEO module - Lists all categories and FAQs from a given Classification. It references the page where the answer is.
Once the web crawlers index this page the search engines should pick up the FAQs and the user should land on the referenced page.

Usage

This package is a @cxco/core plugin and as such it needs it to work. It also needs @cxco/api-dcx to connect the core to DigitalCX.

import CxcoCore from '@cxco/core'
import cxcoDcxApi from '@cxco/api-dcx'
// import the UI-SEO package
import cxcoSeoWidget from '@cxco/ui-seo'

const instance = new CxcoCore({ useWindowConfig: true, useWindowApi: true })
const rootElement = document.createElement('div')
// use it as a Cxco Core plugin
instance.use(cxcoSeoWidget(rootElement))
instance.use(cxcoDcxApi({}))

Configuration

The SEO module uses some common properties from cxcoConfig but has it's own.

// configuration

window.cxcoConfig = {
    project: {
        publicApiKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
        culture: 'xx',
        customerKey: 'customerA',
        key: 'projectB'
    },
    seo: {
        parentSelector: '[data-cxco-seo]'
        classificationId: 97,
        href: '/help#!{categoryname}/{faqid}/{question}'
    }
};

SEO Options window.cxcoConfig.seo

option	optional	description	example
href	mandatory	Defines the format of the href that is used to navigate to the page where the answer is displayed	'/help#!{categoryname}/{faqid}/{question}'
classificationId	mandatory	Classification Id to load the Categories and FAQs from	1
parentSelector	mandatory	A DOMString selector to define where the SEO Module should be injected	'[data-cxco-seo]'