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.

Sign up for GitHub

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

Adds required/optional tag option to accordion #1881

Merged
merged 6 commits into from
May 17, 2024
Merged

Adds required/optional tag option to accordion #1881

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
86d4552
Adds required/optional tag option to accordion
irislam94 May 17, 2024
3ccbdaf
lint
irislam94 May 17, 2024
b4ca3a9
updates snapshot
irislam94 May 17, 2024
9184d9b
Update variable name
irislam94 May 17, 2024
a128d66
lint agani
irislam94 May 17, 2024
073f20d
Removes 100% width
irislam94 May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/shared-components/accordion/__snapshots__/test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ exports[`<Accordion /> UI snapshots renders disabled accordion 1`] = `
border-bottom: none;
}

.emotion-1:last-of-type .css-sk7hsm-TitleWrapper:focus {
.emotion-1:last-of-type .css-gt5ld8-TitleWrapper:focus {
border-bottom-left-radius: 4px;
border-bottom-right-radius: 4px;
}
Expand Down
7 changes: 7 additions & 0 deletions src/shared-components/accordion/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ export interface AccordionProps {
disabled?: boolean;
/** determine if the accordion is collapsed (false) or expanded (true) */
isOpen: boolean;
/** show if the photo is required */
isRequired?: boolean;
/** when true, shows Required/Optional tag */
showRequiredTag?: boolean;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might change the name of showRequiredTag to something like displayRequiredOrOptionalText.

The naming as is feels too similar to isRequired. Even with the comment block, I didn't fully understand the point of having both variables until looking at the actual code that references them.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea, I'll make the change!

/** when true, border lines between accordions and title/children nodes will disappear */
noBorder?: boolean;
/** invoked when title node is clicked */
Expand Down Expand Up @@ -45,6 +49,8 @@ export const Accordion: Accordion = ({
children,
disabled = false,
isOpen,
isRequired = false,
showRequiredTag = false,
noBorder = false,
onClick,
rightAlignArrow = false,
Expand Down Expand Up @@ -94,6 +100,7 @@ export const Accordion: Accordion = ({
aria-expanded={isOpen}
>
<Style.Truncate>{title}</Style.Truncate>
{showRequiredTag && <Style.Tag>{isRequired ? 'Required' : 'Optional'}</Style.Tag>}
<Style.ArrowWrapper rightAlign={!!rightAlignArrow}>
<ChevronIcon rotate={isOpen ? 90 : 0} fill={theme.COLORS.primary} />
</Style.ArrowWrapper>
Expand Down
11 changes: 11 additions & 0 deletions src/shared-components/accordion/style.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,23 @@ const Container = styled.div<{
}}
`;

const Tag = styled.div`
display: flex;
align-items: center;
justify-content: flex-end;
font-size: 0.75rem;
font-weight: normal;
padding: ${SPACER.medium} 0;
width: 100%;
`;

export default {
AccordionBox,
ArrowWrapper,
Container,
Content,
ExpansionWrapper,
Tag,
TitleWrapper,
Truncate,
};
34 changes: 34 additions & 0 deletions stories/accordion/index.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,40 @@ WithControls.parameters = {
chromatic: { disable: true },
};

export const WithRequiredTag = () => {
const [isOpen, setIsOpen] = useState(false);
const onClick = () => {
setIsOpen(!isOpen);
};

return (
<Accordion.Container>
<Accordion
title={
<Accordion.Content>
This is Accordion with required/optional tag
</Accordion.Content>
}
noBorder
isOpen={isOpen}
isRequired={boolean('isRequired', true)}
showRequiredTag={boolean('showRequiredTag', true)}
onClick={onClick}
>
<Accordion.Content>
This is styled with Accordion.Content
</Accordion.Content>
</Accordion>
</Accordion.Container>
);
};

WithControls.id = `${ACCORDION_STORY_ID_PREFIX}with-required-tag`;

WithControls.parameters = {
chromatic: { disable: true },
};

interface AccordionStories extends Meta {
title: string;
}
Expand Down
Loading