Skip to content

feat: style of sandbox note #351

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
twjeffery merged 2 commits into from
May 8, 2025
Merged

feat: style of sandbox note #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78d01d4
feat: style of sandbox note
twjeffery May 1, 2025
4777287
update from review
twjeffery May 7, 2025
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
3 changes: 3 additions & 0 deletions src/components/sandbox/Sandbox.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.sandbox-note {
color: #666;
margin-top: var(--goa-space-m);
margin-bottom: var(--goa-space-2xl);
font: var(--goa-typography-body-s);
}

.sandbox-render {
Expand Down
20 changes: 18 additions & 2 deletions src/components/sandbox/Sandbox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { ReactElement, ReactNode, useContext, useEffect, useState } from "react";
import { GoabCallout } from "@abgov/react-components";
import { GoabCalloutType } from "@abgov/ui-components-common";

import SandboxProperties from "./SandboxProperties";
import { CodeSnippet } from "@components/code-snippet/CodeSnippet";
Expand All @@ -22,7 +24,7 @@ type Serializer = (el: any, properties: ComponentBinding[]) => string;
interface SandboxProps {
properties?: ComponentBinding[];
formItemProperties?: ComponentBinding[];
note?: string;
note?: string | { type?: GoabCalloutType; heading?: string; content: string };
Comment thread
bdfranck marked this conversation as resolved.
fullWidth?: boolean;
onChange?: (bindings: ComponentBinding[], props: Record<string, unknown>) => void;
onChangeFormItemBindings?: (bindings: ComponentBinding[], props: Record<string, unknown>) => void;
Expand Down Expand Up @@ -140,7 +142,21 @@ export const Sandbox = (props: SandboxProps) => {
</GoabAccordion>
)}
<SandboxCode props={props} formatLang={formatLang} lang={lang} serializers={serializers} version={version} />
{props.note && (<div className="sandbox-note">{props.note}</div>)}
{props.note &&
(typeof props.note === "string" ? (
<p className="sandbox-note">{props.note}</p>
) : (
<GoabCallout
type={props.note.type || "important"}
size="medium"
heading={props.note.heading}
maxWidth="596px"
mt="m"
mb="2xl"
>
{props.note.content}
</GoabCallout>
))}
</>
);
};
Expand Down
7 changes: 6 additions & 1 deletion src/examples/modal/ModalWarnUserDeadlineExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ export const ModalWarnUserDeadlineExample = () => {
const {version} = useContext(LanguageVersionContext);
const [warnCalloutModalOpen, setWarnCalloutModalOpen] = useState<boolean>();
return (
<Sandbox skipRender>
<Sandbox skipRender
note={{
type: "important",
heading: "AlertDialog Accessibility",
content: "Do not make the modal closeable or add any focusable elements before the action button when using an AlertDialog. This ensures that the screen reader will announce the full content."
}}>
<GoabButton type="secondary" onClick={() => setWarnCalloutModalOpen(true)}>
Save for later
</GoabButton>
Expand Down