File size: 2,880 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
import { Badge } from '@automattic/ui';
import {
__experimentalVStack as VStack,
__experimentalHStack as HStack,
__experimentalText as Text,
Button,
Icon,
} from '@wordpress/components';
import { chevronRight } from '@wordpress/icons';
import clsx from 'clsx';
import React, { forwardRef } from 'react';
import { SummaryButtonProps } from './types';
import './style.scss';
function BadgesList( { badges }: { badges: SummaryButtonProps[ 'badges' ] } ) {
if ( ! badges?.length ) {
return null;
}
return (
<HStack spacing={ 1 } justify="flex-start" as="span" wrap expanded={ false }>
{ badges?.map( ( badge ) => (
<Badge key={ badge.text } intent={ badge.intent }>
{ badge.text }
</Badge>
) ) }
</HStack>
);
}
function UnforwardedSummaryButton(
{
title,
href,
decoration,
description,
strapline,
badges,
showArrow = true,
onClick,
disabled,
density = 'low',
...props
}: SummaryButtonProps,
ref: React.ForwardedRef< HTMLAnchorElement | HTMLButtonElement >
) {
const hasLowDensity = density === 'low';
return (
<Button
// Forward additional props to support standard attributes like mouse events.
{ ...props }
ref={ ref }
href={ href }
onClick={ onClick }
className={ clsx( 'summary-button', `has-density-${ density }`, props.className ) }
disabled={ disabled }
accessibleWhenDisabled
>
<HStack spacing={ 4 } justify="flex-start" alignment="flex-start" as="span">
{ !! decoration && <span className="summary-button-decoration">{ decoration }</span> }
<HStack justify="space-between" spacing={ 4 } as="span" wrap>
<VStack alignment="flex-start" as="span" spacing={ 3 } justify="flex-start">
<VStack alignment="flex-start" as="span" spacing={ 2 } justify="flex-start">
{ strapline && hasLowDensity && (
<Text variant="muted" size={ 10 } upperCase className="summary-button-strapline">
{ strapline }
</Text>
) }
<Text className="summary-button-title">{ title }</Text>
{ description && hasLowDensity && (
<Text variant="muted" className="summary-button-description">
{ description }
</Text>
) }
</VStack>
{ hasLowDensity && <BadgesList badges={ badges } /> }
</VStack>
{ ! hasLowDensity && <BadgesList badges={ badges } /> }
</HStack>
{ showArrow && <Icon icon={ chevronRight } className="summary-button-navigation-icon" /> }
</HStack>
</Button>
);
}
export const SummaryButton = forwardRef( UnforwardedSummaryButton );
/**
* The SummaryButton component provides a quick overview of a related page
* (often settings). It includes a title, supporting description, and may
* optionally display key field values or status indicators (e.g. a "2FA enabled" badge)
* to surface the current state of settings at a glance.
*/
export default SummaryButton;
|