Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Spaced avatar group style #550

10 changes: 10 additions & 0 deletions src/components/Avatar/Avatar.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,11 @@ interface MaxAvatarProps extends BaseAvatarProps {
interface AvatarListProps
extends Omit<ListProps<ReactNode>, 'footer' | 'header' | 'layout'> {}

export enum AvatarGroupVariant {
Overlapped = 'overlapped',
Spaced = 'spaced',
}

export interface AvatarGroupProps extends OcBaseProps<HTMLDivElement> {
/**
* Avatar group List props.
Expand All @@ -186,6 +191,11 @@ export interface AvatarGroupProps extends OcBaseProps<HTMLDivElement> {
* @default '18px'
*/
fontSize?: string;
/**
* Avatar grouping variant
* @default AvatarGroupVariant.Overlapped
*/
groupVariant?: AvatarGroupVariant;
/**
* Avatar group max props.
*/
Expand Down
18 changes: 16 additions & 2 deletions src/components/Avatar/AvatarGroup.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from 'react';
import { Stories } from '@storybook/addon-docs';
import { ComponentStory, ComponentMeta } from '@storybook/react';
import { Avatar, AvatarGroup } from '.';
import { ComponentMeta, ComponentStory } from '@storybook/react';
import { Avatar, AvatarGroup, AvatarGroupVariant } from '.';
import { Tooltip, TooltipSize, TooltipTheme } from '../Tooltip';

export default {
Expand Down Expand Up @@ -131,6 +131,8 @@ const Basic_Story: ComponentStory<typeof AvatarGroup> = (args) => (

export const Basic = Basic_Story.bind({});

export const Basic_Spaced = Basic_Story.bind({});

const List_Story: ComponentStory<typeof AvatarGroup> = (args) => (
<AvatarGroup
{...args}
Expand Down Expand Up @@ -165,6 +167,8 @@ const List_Story: ComponentStory<typeof AvatarGroup> = (args) => (

export const List_Group = List_Story.bind({});

export const List_Group_Spaced = List_Story.bind({});

const avatarGroupArgs: Object = {
classNames: 'my-avatar-group-class',
'data-test-id': 'my-avatar-group-test-id',
Expand All @@ -179,6 +183,16 @@ Basic.args = {
...avatarGroupArgs,
};

Basic_Spaced.args = {
...avatarGroupArgs,
groupVariant: AvatarGroupVariant.Spaced,
};

List_Group.args = {
...avatarGroupArgs,
};

List_Group_Spaced.args = {
...avatarGroupArgs,
groupVariant: AvatarGroupVariant.Spaced,
};
4 changes: 3 additions & 1 deletion src/components/Avatar/AvatarGroup.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React, { Ref } from 'react';
import { Avatar, AvatarGroupProps } from '.';
import { Avatar, AvatarGroupProps, AvatarGroupVariant } from '.';
import { List } from '../List';
import { Tooltip } from '../Tooltip';
import { useCanvasDirection } from '../../hooks/useCanvasDirection';
Expand All @@ -18,6 +18,7 @@ export const AvatarGroup: React.FC<AvatarGroupProps> = React.forwardRef(
avatarListProps,
children,
classNames,
groupVariant = AvatarGroupVariant.Overlapped,
maxProps,
size,
style,
Expand All @@ -31,6 +32,7 @@ export const AvatarGroup: React.FC<AvatarGroupProps> = React.forwardRef(

const avatarGroupClassNames: string = mergeClasses([
styles.avatarGroup,
{ [styles.spaced]: groupVariant === AvatarGroupVariant.Spaced },
{ [styles.avatarGroupRtl]: htmlDir === 'rtl' },
classNames,
]);
Expand Down
6 changes: 6 additions & 0 deletions src/components/Avatar/Styles/group.scss
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
margin-left: -$space-xs;
}

&.spaced {
:not(:first-child):not(.avatar-group-tooltip) {
margin-left: -$space-xxxs;
}
}

.avatar {
border: $space-xxxs solid var(--background-color);
}
Expand Down
7 changes: 7 additions & 0 deletions src/components/Avatar/Styles/rtl.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,12 @@
margin-right: -$space-xs;
margin-left: 0;
}

&.spaced {
:not(:first-child):not(.avatar-group-spaced-tooltip) {
margin-right: -$space-xxxs;
margin-left: 0;
}
}
}
}
10 changes: 9 additions & 1 deletion src/octuple.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ import {
AccordionSize,
} from './components/Accordion';

import { AVATAR_THEME_SET, Avatar, AvatarGroup } from './components/Avatar';
import {
AVATAR_THEME_SET,
Avatar,
AvatarGroup,
AvatarGroupVariant,
StatusItemsPosition,
} from './components/Avatar';

import { Badge } from './components/Badge';

Expand Down Expand Up @@ -204,6 +210,7 @@ export {
AVATAR_THEME_SET,
Avatar,
AvatarGroup,
AvatarGroupVariant,
Badge,
ButtonIconAlign,
ButtonShape,
Expand Down Expand Up @@ -316,6 +323,7 @@ export {
Stack,
Stat,
StatThemeName,
StatusItemsPosition,
StatValidationStatus,
Step,
StepSize,
Expand Down