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

Jump to bottom

Docs: removed hidden examples for VR #3790

Merged
merged 2 commits into from
Oct 2, 2024
Merged

Docs: removed hidden examples for VR #3790

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
d16c2d0
more
AlbertCarreras Oct 2, 2024
8be99b3
more
AlbertCarreras Oct 2, 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
35 changes: 15 additions & 20 deletions docs/pages/web/iconbutton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import defaultStateExample from 'docs/examples/iconbutton/defaultStateExample';
import disabledStateExample from 'docs/examples/iconbutton/disabledStateExample';
import focusOnDarkBackground from 'docs/examples/iconbutton/focusOnDarkBackground';
import selectedStateExample from 'docs/examples/iconbutton/selectedStateExample';
import { IconButton, Pog, useDangerouslyInGestaltExperiment } from 'gestalt';
import { IconButton, Pog } from 'gestalt';
import AccessibilitySection from '../../docs-components/AccessibilitySection';
import CombinationNew from '../../docs-components/CombinationNew';
import docGen, { DocGen } from '../../docs-components/docgen';
Expand Down Expand Up @@ -30,11 +30,6 @@ import tooltip from '../../examples/iconbutton/tooltip';
import tooltipVariant from '../../examples/iconbutton/tooltipVariant';

export default function DocsPage({ generatedDocGen }: { generatedDocGen: DocGen }) {
const isInExperiment = useDangerouslyInGestaltExperiment({
webExperimentName: 'web_gestalt_visualRefresh',
mwebExperimentName: 'web_gestalt_visualRefresh',
});

return (
<Page title={generatedDocGen?.displayName}>
<PageHeader
Expand Down Expand Up @@ -225,20 +220,20 @@ It is recommended to use short labels for IconButtons, but the label will wrap u
sandpackExample={<SandpackExample code={label} name="Label example" />}
/>
</MainSection.Subsection>
{isInExperiment && (
<MainSection.Subsection title="Focus ring on dark backgrounds">
<MainSection.Card
cardSize="lg"
description="IconButtonLink can be used on dark backgrounds. The focus ring is visible on dark backgrounds to ensure accessibility."
sandpackExample={
<SandpackExample
code={focusOnDarkBackground}
name="Usage of focus ring on dark backgrounds"
/>
}
/>
</MainSection.Subsection>
)}

<MainSection.Subsection title="Focus ring on dark backgrounds">
<MainSection.Card
cardSize="lg"
description="IconButtonLink can be used on dark backgrounds. The focus ring is visible on dark backgrounds to ensure accessibility."
sandpackExample={
<SandpackExample
code={focusOnDarkBackground}
name="Usage of focus ring on dark backgrounds"
/>
}
/>
</MainSection.Subsection>

<MainSection.Subsection
description={`IconButton can be presented in combinations of icon and background colors. In the absence of combinations, for each \`iconColor\` or \`bgColor\` value, a default paired value is assigned.

Expand Down
34 changes: 14 additions & 20 deletions docs/pages/web/iconbuttonlink.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import focusOnDarkBackground from 'docs/examples/iconbuttonlink/focusOnDarkBackground';
import { BannerSlim, Icon, useDangerouslyInGestaltExperiment } from 'gestalt';
import { BannerSlim, Icon } from 'gestalt';
import docGen, { DocGen, DocType, overrideTypes } from '../../docs-components/docgen';
import GeneratedPropTable from '../../docs-components/GeneratedPropTable';
import InternalDocumentationSection from '../../docs-components/InternalDocumentationSection';
Expand All @@ -13,11 +13,6 @@ import localizationLabels from '../../examples/iconbuttonlink/localizationLabels
import main from '../../examples/iconbuttonlink/main';

export default function DocsPage({ generatedDocGen }: DocType) {
const isInExperiment = useDangerouslyInGestaltExperiment({
webExperimentName: 'web_gestalt_visualRefresh',
mwebExperimentName: 'web_gestalt_visualRefresh',
});

return (
<Page title={generatedDocGen?.displayName}>
<PageHeader
Expand Down Expand Up @@ -63,20 +58,19 @@ See [GlobalEventsHandlerProvider](/web/utilities/globaleventshandlerprovider#onN
`}
title="External handlers"
/>
{isInExperiment && (
<MainSection.Subsection title="Focus ring on dark backgrounds">
<MainSection.Card
cardSize="lg"
description="IconButtonLink can be used on dark backgrounds. The focus ring is visible on dark backgrounds to ensure accessibility."
sandpackExample={
<SandpackExample
code={focusOnDarkBackground}
name="Usage of focus ring on dark backgrounds"
/>
}
/>
</MainSection.Subsection>
)}

<MainSection.Subsection title="Focus ring on dark backgrounds">
<MainSection.Card
cardSize="lg"
description="IconButtonLink can be used on dark backgrounds. The focus ring is visible on dark backgrounds to ensure accessibility."
sandpackExample={
<SandpackExample
code={focusOnDarkBackground}
name="Usage of focus ring on dark backgrounds"
/>
}
/>
</MainSection.Subsection>
</MainSection>

<QualityChecklist component={generatedDocGen?.displayName} />
Expand Down
Loading