@salesforce/design-system-react/components/trial-bar/index.jsx

Salesforce Lightning Design System for React

/* Copyright (c) 2015-present, salesforce.com, inc. All rights reserved */
/* Licensed under BSD 3-Clause - see LICENSE.txt or git.io/sfdc-license */

// Implements the [Trial Bar design pattern](https://lightningdesignsystem.com/components/trial-bar/) in React.
// Based on SLDS v2.4.5
import React from 'react';
import PropTypes from 'prop-types';
import classNames from 'classnames';

import { TRIAL_BAR } from '../../utilities/constants';

const propTypes = {
	/**
	 * Provide children of the types `<TrialBarButton />` or `<TrialBarDropdown />` to define the structure of the trial bar.
	 * ```
	 * <TrialBar>
	 *   <TrialBarButton />
	 *   <TrialBarDropdown />
	 * </TrialBar>
	 * ```
	 */
	children: PropTypes.node,

	/**
	 * CSS classes to be added to the component. Uses `classNames` [API](https://github.com/JedWatson/classnames).
	 */
	className: PropTypes.oneOfType([
		PropTypes.array,
		PropTypes.object,
		PropTypes.string,
	]),
	/**
	 * Renders the labels in the trial bar.
	 */
	labels: PropTypes.shape({
		/** Amount of time left in trial, e.g. `30` */
		timeLeft: PropTypes.string,
		/** Unit of the amount of time left, e.g. `days` */
		timeLeftUnit: PropTypes.string,
	}),
	/**
	 * Renders the actions section of the trial bar.
	 */
	onRenderActions: PropTypes.func,
	/**
	 * Customs styles to be applied to the component.
	 */
	style: PropTypes.object,
};

/**
 * Trial bar components are used to provide an interactive and educational prospect experience for setup.
 */
const TrialBar = (props) => (
	<div
		className={classNames('slds-trial-header slds-grid', props.className)}
		style={props.style}
	>
		<div className="slds-grid">{props.children}</div>
		<div className="slds-grid slds-grid_vertical-align-center slds-col_bump-left">
			<span className="slds-box slds-box_xx-small slds-theme_default">
				{props.labels.timeLeft}
			</span>
			<span className="slds-m-horizontal_x-small">
				{props.labels.timeLeftUnit} left in trial
			</span>
			{props.onRenderActions()}
		</div>
	</div>
);

TrialBar.displayName = TRIAL_BAR;
TrialBar.propTypes = propTypes;

export default TrialBar;