woocommerce/packages/js/customer-effort-score
Lourens Schep 137ec24174 Add changelogs for customer-effort-score package 2022-05-16 10:36:30 -03:00
..
changelog Add changelogs for customer-effort-score package 2022-05-16 10:36:30 -03:00
src Make sure Modal emoji's match 2022-05-16 10:27:35 -03:00
typings Moved WCA Packages 2022-03-18 14:25:26 -07:00
.eslintrc.js Add .eslintrc config to each packages 2022-03-29 16:08:07 +08:00
.npmrc Moved WCA Packages 2022-03-18 14:25:26 -07:00
CHANGELOG.md Bumped WCA JS package version numbers 2022-03-22 16:08:24 +08:00
README.md Moved WCA Packages 2022-03-18 14:25:26 -07:00
composer.json Packages: Add Changelogger scripts (#32813) 2022-05-05 15:26:36 +12:00
composer.lock Packages: Add Changelogger scripts (#32813) 2022-05-05 15:26:36 +12:00
jest.config.json Moved WCA Packages 2022-03-18 14:25:26 -07:00
package.json Fix customer effort types and add timeout to thank you message 2022-05-13 10:29:21 -03:00
project.json Add build-watch to most js packages and remove packages watch from woocommerce-admin command 2022-03-30 11:46:12 -03:00
tsconfig-cjs.json Added EOF Newlines 2022-05-10 13:35:31 -07:00
tsconfig.json Fix customer effort types and add timeout to thank you message 2022-05-13 10:29:21 -03:00
webpack.config.js Moved WCA Packages 2022-03-18 14:25:26 -07:00

README.md

Customer Effort Score

WooCommerce utility to measuring user satisfaction.

Installation

Install the module

pnpm install @woocommerce/customer-effort-score --save

This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.

Usage

CustomerEffortScore component

CustomerEffortScore is a React component that can be used to implement your own effort score survey, providing your own logging infrastructure.

This creates a wrapper component around CustomerEffortScore which simply logs responses to the console:

import CustomerEffortScore from '@woocommerce/customer-effort-score';

export function CustomerEffortScoreConsole( { label } ) {
    const onNoticeShown = () => console.log( 'onNoticeShown' );
    const onModalShown = () => console.log( 'onModalShown' );
    const onNoticeDismissed = () => console.log( 'onNoticeDismissed' );
    const recordScore = ( score, comments ) => console.log( { score, comments } );

    return (
        <CustomerEffortScore
			recordScoreCallback={ recordScore }
			label={ label }
			onNoticeShownCallback={ onNoticeShown }
			onNoticeDismissedCallback={ onNoticeDismissed }
			onModalShownCallback={ onModalShown }
			icon={
				<span
					style={ { height: 21, width: 21 } }
					role="img"
					aria-label="Pencil icon"
				>
					✏️
				</span>
			}
        />
    );
};

Use this wrapper component in your code like this:

const MyComponent = function() {
    const [ ceses, setCeses ] = useState( [] );
	
    const addCES = () => {
		setCeses( 
			ceses.concat( 
				<CustomerEffortScoreConsole
					label={ `survey ${ceses.length + 1}` }
					key={ ceses.length + 1 }
				/> 
			) 
		);
	};

    return (
        <>
            { ceses }
            <button onClick={ addCES }>Show new survey</button>
        </>
    );
};