File "index.tsx"

Full Path: /home/vantageo/public_html/cache/cache/cache/cache/cache/.wp-cli/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/base/components/summary/index.tsx
File size: 1.06 KB
MIME-type: text/x-java
Charset: utf-8

/**
 * External dependencies
 */
import { RawHTML, useMemo } from '@wordpress/element';
import { WordCountType } from '@woocommerce/block-settings';

/**
 * Internal dependencies
 */
import { generateSummary } from './utils';

interface SummaryProps {
	className?: string;
	source: string;
	maxLength?: number;
	countType?: WordCountType;
}
/**
 * Summary component.
 *
 * @param {Object} props Component props.
 * @param {string} props.source Source text.
 * @param {number} props.maxLength Max length of the summary, using countType.
 * @param {string} props.countType One of words, characters_excluding_spaces, or characters_including_spaces.
 * @param {string} props.className Class name for rendered component.
 */
export const Summary = ( {
	source,
	maxLength = 15,
	countType = 'words',
	className = '',
}: SummaryProps ): JSX.Element => {
	const summaryText = useMemo( () => {
		return generateSummary( source, maxLength, countType );
	}, [ source, maxLength, countType ] );

	return <RawHTML className={ className }>{ summaryText }</RawHTML>;
};

export default Summary;