Skip to content

docs(Wizard): show entire code of the example #5007

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

Merged
merged 4 commits into from
Aug 25, 2023
Merged

docs(Wizard): show entire code of the example #5007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54eba26
docs(Wizard): show entire code of the example
Lukas742 Aug 24, 2023
8a925d9
Merge branch 'main' into docs/wizard-react-state
Lukas742 Aug 24, 2023
68f0042
Update Wizard.stories.tsx
Lukas742 Aug 25, 2023
1c6cd15
Update Wizard.mdx
Lukas742 Aug 25, 2023
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
125 changes: 124 additions & 1 deletion packages/main/src/webComponents/Wizard/Wizard.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,130 @@ import { excludePropsForAbstract } from '@sb/utils';

## Example

<Canvas of={ComponentStories.Default} />
<Canvas of={ComponentStories.Default} sourceState="none" />

<details>

<summary>Show Code</summary>

```tsx
const WizardComponent = () => {
const [selected, setSelected] = useState('1');
const [disabled, setDisabled] = useState<Record<string, boolean>>({ '2': true, '3': true, '4': true });
const [hidden, setHidden] = useState<Record<string, boolean>>({ step3Btn: true, finalizeBtn: true });
const goToStep2 = () => {
setDisabled((prev) => {
const { '2': _omit, ...rest } = prev;
return rest;
});
setSelected('2');
};
const goToStep3 = () => {
setDisabled((prev) => {
const { '3': _omit, ...rest } = prev;
return rest;
});
setSelected('3');
};
const handleStep2Completed = (e) => {
if (e.target.checked) {
setHidden((prev) => {
const { step3Btn: _omit, ...rest } = prev;
return rest;
});
}
};
const finalizeWizard = () => {
alert('Wizard is now completed!');
};
const handlePriceInput = (e) => {
if (e.target.value) {
setHidden((prev) => {
const { finalizeBtn: _omit, ...rest } = prev;
return rest;
});
}
};
const handleStepChange = (e) => {
setSelected(e.detail.step.dataset.step);
args.onStepChange(e);
};

return (
<Wizard {...args} onStepChange={handleStepChange}>
<WizardStep icon={productIcon} titleText="Product Type" selected={selected === '1'} data-step={'1'}>
<Title>1. Product Type</Title>
<MessageStrip design={MessageStripDesign.Information}>
The Wizard control is supposed to break down large tasks, into smaller steps, easier for the user to work
with.
</MessageStrip>
<Label wrappingType={WrappingType.None}>
Sed fermentum, mi et tristique ullamcorper, sapien sapien faucibus sem, quis pretium nibh lorem malesuada
diam. Nulla quis arcu aliquet, feugiat massa semper, volutpat diam. Nam vitae ante posuere, molestie neque sit
amet, dapibus velit. Maecenas eleifend tempor lorem. Mauris vitae elementum mi, sed eleifend ligula. Nulla
tempor vulputate dolor, nec dignissim quam convallis ut. Praesent vitae commodo felis, ut iaculis felis. Fusce
quis eleifend sapien, eget facilisis nibh. Suspendisse est velit, scelerisque ut commodo eget, dignissim quis
metus. Cras faucibus consequat gravida. Curabitur vitae quam felis. Phasellus ac leo eleifend, commodo tortor
et, varius quam. Aliquam erat volutpat
</Label>
<Button design={ButtonDesign.Emphasized} onClick={goToStep2}>
Step 2
</Button>
</WizardStep>
<WizardStep
icon={hintIcon}
titleText="Product Information"
disabled={disabled['2']}
selected={selected === '2'}
data-step={'2'}
>
<Title>2. Product Information</Title>
<Label wrappingType={WrappingType.None}>
Integer pellentesque leo sit amet dui vehicula, quis ullamcorper est pulvinar. Nam in libero sem. Suspendisse
arcu metus, molestie a turpis a, molestie aliquet dui. Donec ppellentesque leo sit amet dui vehicula, quis
ullamcorper est pulvinar. Nam in libero sem. Suspendisse arcu metus, molestie a turpis a, molestie aliquet
dui. Donec pulvinar, sapien corper eu, posuere malesuada nisl. Integer pellentesque leo sit amet dui vehicula,
quis ullamcorper est pulvinar. Nam in libero sem. Suspendisse arcu metus, molestie a turpis a, molestie
aliquet dui. Donec pulvinar, sapien
</Label>
<CheckBox onChange={handleStep2Completed} text="Step Completed" />
<br />
{!hidden['step3Btn'] && (
<Button design={ButtonDesign.Emphasized} onClick={goToStep3}>
Step 3
</Button>
)}
</WizardStep>
<WizardStep
icon={leadIcon}
titleText="Pricing"
disabled={disabled['3']}
selected={selected === '3'}
data-step={'3'}
>
<Title>3. Pricing</Title>
<Label wrappingType={WrappingType.None}>
Integer pellentesque leo sit amet dui vehicula, quis ullamcorper est pulvinar. Nam in libero sem. Suspendisse
arcu metus, molestie a turpis a, molestie aliquet dui. Donec ppellentesque leo sit amet dui vehicula, quis
ullamcorper est pulvinar. Nam in libero sem. Suspendisse arcu metus, molestie a turpis a, molestie aliquet
dui. Donec pulvinar, sapien corper eu, posuere malesuada nisl. Integer pellentesque leo sit amet dui vehicula,
quis ullamcorper est pulvinar. Nam in libero sem. Suspendisse arcu metus, molestie a turpis a, molestie
aliquet dui. Donec pulvinar, sapien
</Label>
<Input placeholder="Item Price" onInput={handlePriceInput} />
{Br}
{!hidden['finalizeBtn'] && (
<Button design={ButtonDesign.Emphasized} onClick={finalizeWizard}>
Finalize
</Button>
)}
</WizardStep>
</Wizard>
);
};
```

</details>

## Properties

Expand Down
82 changes: 60 additions & 22 deletions packages/main/src/webComponents/Wizard/Wizard.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { Meta, StoryObj } from '@storybook/react';
import hintIcon from '@ui5/webcomponents-icons/dist/hint.js';
import leadIcon from '@ui5/webcomponents-icons/dist/lead.js';
import productIcon from '@ui5/webcomponents-icons/dist/product.js';
import { useRef } from 'react';
import { useState } from 'react';
import { ButtonDesign } from '../../enums/ButtonDesign.js';
import { MessageStripDesign } from '../../enums/MessageStripDesign.js';
import { WrappingType } from '../../enums/WrappingType.js';
Expand Down Expand Up @@ -34,28 +34,50 @@ type Story = StoryObj<typeof meta>;

export const Default: Story = {
render(args) {
const step2 = useRef(null);
const step3 = useRef(null);
const [selected, setSelected] = useState('1');
const [disabled, setDisabled] = useState<Record<string, boolean>>({ '2': true, '3': true, '4': true });
const [hidden, setHidden] = useState<Record<string, boolean>>({ step3Btn: true, finalizeBtn: true });
const goToStep2 = () => {
step2.current.selected = true;
step2.current.disabled = false;
setDisabled((prev) => {
const { '2': _omit, ...rest } = prev;
return rest;
});
setSelected('2');
};
const goToStep3 = () => {
step3.current.selected = true;
step3.current.disabled = false;
setDisabled((prev) => {
const { '3': _omit, ...rest } = prev;
return rest;
});
setSelected('3');
};
const handleStep2Completed = () => {
document.querySelector('#goToStep3').removeAttribute('hidden');
const handleStep2Completed = (e) => {
if (e.target.checked) {
setHidden((prev) => {
const { step3Btn: _omit, ...rest } = prev;
return rest;
});
}
};
const finalizeWizard = () => {
alert('Wizard is now completed!');
};
const handlePriceInput = () => {
document.querySelector('#finalizeBtn').removeAttribute('hidden');
const handlePriceInput = (e) => {
if (e.target.value) {
setHidden((prev) => {
const { finalizeBtn: _omit, ...rest } = prev;
return rest;
});
}
};
const handleStepChange = (e) => {
setSelected(e.detail.step.dataset.step);
args.onStepChange(e);
};

return (
<Wizard {...args}>
<WizardStep icon={productIcon} titleText="Product Type" selected>
<Wizard {...args} onStepChange={handleStepChange}>
<WizardStep icon={productIcon} titleText="Product Type" selected={selected === '1'} data-step={'1'}>
<Title>1. Product Type</Title>
<MessageStrip design={MessageStripDesign.Information}>
The Wizard control is supposed to break down large tasks, into smaller steps, easier for the user to work
Expand All @@ -74,7 +96,13 @@ export const Default: Story = {
Step 2
</Button>
</WizardStep>
<WizardStep icon={hintIcon} titleText="Product Information" disabled ref={step2}>
<WizardStep
icon={hintIcon}
titleText="Product Information"
disabled={disabled['2']}
selected={selected === '2'}
data-step={'2'}
>
<Title>2. Product Information</Title>
<Label wrappingType={WrappingType.None}>
Integer pellentesque leo sit amet dui vehicula, quis ullamcorper est pulvinar. Nam in libero sem.
Expand All @@ -86,12 +114,20 @@ export const Default: Story = {
</Label>
<CheckBox onChange={handleStep2Completed} text="Step Completed" />
{Br}
<Button id="goToStep3" design={ButtonDesign.Emphasized} onClick={goToStep3} hidden>
Step 3
</Button>
{!hidden['step3Btn'] && (
<Button design={ButtonDesign.Emphasized} onClick={goToStep3}>
Step 3
</Button>
)}
</WizardStep>
<WizardStep icon={leadIcon} titleText="Pricing" disabled ref={step3}>
<Title>4. Pricing</Title>
<WizardStep
icon={leadIcon}
titleText="Pricing"
disabled={disabled['3']}
selected={selected === '3'}
data-step={'3'}
>
<Title>3. Pricing</Title>
<Label wrappingType={WrappingType.None}>
Integer pellentesque leo sit amet dui vehicula, quis ullamcorper est pulvinar. Nam in libero sem.
Suspendisse arcu metus, molestie a turpis a, molestie aliquet dui. Donec ppellentesque leo sit amet dui
Expand All @@ -102,9 +138,11 @@ export const Default: Story = {
</Label>
<Input placeholder="Item Price" onInput={handlePriceInput} />
{Br}
<Button design={ButtonDesign.Emphasized} onClick={finalizeWizard} hidden id="finalizeBtn">
Finalize
</Button>
{!hidden['finalizeBtn'] && (
<Button design={ButtonDesign.Emphasized} onClick={finalizeWizard}>
Finalize
</Button>
)}
</WizardStep>
</Wizard>
);
Expand Down