3.4.7 • Published 3 years ago

@cxco/ui-faq v3.4.7

Weekly downloads
10
License
ISC
Repository
bitbucket
Last release
3 years ago

cxco-ui-faq

TODO: description

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-FAQ package
import cxcoFaqWidget from '@cxco/ui-faq'

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

Configuration

For a non-customized version of the "Default FAQ Module" the only thing you need to include in your HTML page is this:

<script>
    window.cxcoConfig = {
    /* project/database configuration */
        project: {
            publicApiKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
            culture: 'xx',
            customerKey: 'customerA',
            key: 'projectB'
        },
        faq: {
            classificationId: 97,
            classificationName: 'Classification Name',
            /* HTML element where the FAQ will attacht to*/
            parentSelector: '[data-cxco-faq]'         
        }
    };

    cxco = window.cxco || [];

    (function (d, t) {
        var g = d.createElement(t),
            s = d.getElementsByTagName(t)[0];
        g.src = '//projects.elitechnology.com/jsprojects/cxco/default-faq/init.js?v='+(+new Date);
        g.async = true;
        s.parentNode.insertBefore(g, s);
    }(document, 'script'));
</script>

FAQ Options window.cxcoConfig.faq

optionoptionaldescriptionexample
classificationIdmandatoryClassification Id to load the contextual FAQs from1
classificationNameoptionalClassification Name to be displayed above the first column"All Categories"
parentSelectormandatoryA DOMString selector to define where the bot is injected[data-cxco-faq]
showNumberingoptionalShow numbers next to the Category names"All Categories"
urlQuestionoptionalURL format to read from, and open the corresponding FAQ"#{categorycrumbs}/{categoryname}/{faqid}/{question}"
maxBreakpointsoptionalSets the maximum amount of breakpoints for each category columns1
3.4.7

3 years ago

3.4.6

3 years ago

3.4.5

3 years ago

3.4.4

3 years ago

3.4.1

3 years ago

3.4.0

3 years ago

3.3.0

4 years ago

3.2.0

4 years ago

3.1.2

4 years ago

3.1.0

4 years ago

3.0.1

4 years ago

3.0.0

4 years ago

2.2.0

5 years ago

2.1.1

5 years ago