Skip to content

Commit ffdf4e3

Browse files
committed
docs: fix new-theme-override example, fix relative hrefs
1 parent e45c432 commit ffdf4e3

6 files changed

Lines changed: 72 additions & 12 deletions

File tree

docs/theming/new-theme-overrides.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -544,16 +544,16 @@ type: example
544544
<Table caption="Independent overrides: ColHeader purple, RowHeader deeppink">
545545
<Table.Head>
546546
<Table.Row>
547-
<Table.ColHeader id="h-row">TableColHeader — purple</Table.ColHeader>
548-
<Table.ColHeader id="h-col">TableColHeader — purple</Table.ColHeader>
547+
<Table.ColHeader id="row-headers">Row headers column - purple</Table.ColHeader>
548+
<Table.ColHeader id="cells">Cells column - purple</Table.ColHeader>
549549
</Table.Row>
550550
</Table.Head>
551551
<Table.Body>
552552
<Table.Row>
553553
<Table.RowHeader>TableRowHeader — deeppink</Table.RowHeader>
554554
<Table.Cell>TableCell — unchanged</Table.Cell>
555555
</Table.Row>
556-
<Table.Row>
556+
<Table.Row>
557557
<Table.RowHeader>TableRowHeader — deeppink</Table.RowHeader>
558558
<Table.Cell>TableCell — unchanged</Table.Cell>
559559
</Table.Row>

packages/__docs__/src/App/index.tsx

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ import {
7070
} from '../versionData'
7171
import {
7272
parseCurrentUrl,
73+
navigateTo,
7374
navigateToVersion,
7475
getDeployBase,
7576
MINOR_VERSION_REGEX
@@ -699,7 +700,16 @@ class App extends Component<AppProps, AppState> {
699700
return (
700701
<Alert variant="info" margin="0 0 medium">
701702
{subject} is designed for components for <strong>v11.7</strong> and
702-
later. <Link href={v11_7Href}>Switch to v11.7</Link>
703+
later.{' '}
704+
<Link
705+
href={v11_7Href}
706+
onClick={(e) => {
707+
e.preventDefault()
708+
this.handleMinorVersionChange('v11_7')
709+
}}
710+
>
711+
Switch to v11.7
712+
</Link>
703713
</Alert>
704714
)
705715
}
@@ -832,7 +842,13 @@ class App extends Component<AppProps, AppState> {
832842
<Alert variant="info" margin="xx-large 0">
833843
This page is made for the latest version (
834844
{this.getLatestMinorVersion()?.replace('_', '.')}) of InstUI.{' '}
835-
<Link href="component-versioning">
845+
<Link
846+
href="component-versioning"
847+
onClick={(e) => {
848+
e.preventDefault()
849+
navigateTo('component-versioning')
850+
}}
851+
>
836852
Learn more about the versioning system
837853
</Link>
838854
</Alert>

packages/__docs__/src/Document/index.tsx

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ import { TableOfContents } from '../TableOfContents'
4343
import { Heading } from '../Heading'
4444

4545
import { AppContext } from '../appContext'
46+
import { navigateTo } from '../navigationUtils'
4647

4748
import { allowedProps } from './props'
4849
import type { DocumentProps, DocumentState, DocDataType } from './props'
@@ -203,7 +204,15 @@ class Document extends Component<DocumentProps, DocumentState> {
203204
<View margin="small 0" display="block">
204205
The easiest way to do this is to utilize the{' '}
205206
<code>themeOverride</code> property. See the{' '}
206-
<Link href="#legacy-theme-overrides">Legacy theme overrides</Link>{' '}
207+
<Link
208+
href="legacy-theme-overrides"
209+
onClick={(e) => {
210+
e.preventDefault()
211+
navigateTo('legacy-theme-overrides')
212+
}}
213+
>
214+
Legacy theme overrides
215+
</Link>{' '}
207216
guide for more info and alternative methods.
208217
</View>
209218

@@ -307,7 +316,16 @@ import { ${importName} } from '${versionedPackageName}'`
307316
<View as="div" margin="small 0 0 0">
308317
This import is pinned to the selected component version; future
309318
breaking changes land at new paths. For other import styles, see the{' '}
310-
<Link href="component-versioning">Component versioning</Link> guide.
319+
<Link
320+
href="component-versioning"
321+
onClick={(e) => {
322+
e.preventDefault()
323+
navigateTo('component-versioning')
324+
}}
325+
>
326+
Component versioning
327+
</Link>{' '}
328+
guide.
311329
</View>
312330
</View>
313331
)

packages/__docs__/src/Icons/index.tsx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Spinner } from '@instructure/ui-spinner'
2727
import { View } from '@instructure/ui-view'
2828
import { Alert } from '@instructure/ui-alerts'
2929
import { Link } from '@instructure/ui-link'
30+
import { navigateTo } from '../navigationUtils'
3031

3132
// Lazy load icons gallery component
3233
const IconsGallery = lazy(() => import('./IconsGallery'))
@@ -50,9 +51,17 @@ const IconsPage = () => {
5051
<Alert variant="info" margin="0 0 medium">
5152
The version selector does not affect this page. For icons compatible
5253
with older versions, use{' '}
53-
<Link href="/legacy-icons">Legacy Icons</Link>. These icons are only
54-
meant to be used with the new theming system, please do not use them
55-
with the old (pre v11.7) components.
54+
<Link
55+
href="legacy-icons"
56+
onClick={(e) => {
57+
e.preventDefault()
58+
navigateTo('legacy-icons')
59+
}}
60+
>
61+
Legacy Icons
62+
</Link>
63+
. These icons are only meant to be used with the new theming system,
64+
please do not use them with the old (pre v11.7) components.
5665
</Alert>
5766
<IconsGallery />
5867
</Suspense>

packages/__docs__/src/LegacyIcons/index.tsx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ import { SourceCodeEditor } from '@instructure/ui-source-code-editor'
4242
import * as InstIcons from '@instructure/ui-icons'
4343
import { IconXSolid } from '@instructure/ui-icons'
4444
import { Link } from '@instructure/ui-link'
45+
import { navigateTo } from '../navigationUtils'
4546
import { Flex } from '@instructure/ui-flex'
4647
import type { Glyph, LegacyIconsData } from '../../buildScripts/DataTypes.mjs'
4748

@@ -249,7 +250,16 @@ const LegacyIconsPage = ({ iconData }: LegacyIconsPageProps) => {
249250
</Alert>
250251
<Alert variant="info" margin="0 0 medium">
251252
New icon set is available, please only use it with InstUI v11.7 or newer
252-
components: <Link href="/icons">Icons</Link>
253+
components:{' '}
254+
<Link
255+
href="icons"
256+
onClick={(e) => {
257+
e.preventDefault()
258+
navigateTo('icons')
259+
}}
260+
>
261+
Icons
262+
</Link>
253263
</Alert>
254264
<Alert variant="info" margin="0 0 medium">
255265
Our legacy icon components are rendered through Emotion, so server-side

packages/__docs__/src/Theme/index.tsx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import { Alert } from '@instructure/ui-alerts'
3434
import { Spinner } from '@instructure/ui-spinner'
3535
import { Link } from '@instructure/ui-link'
3636

37+
import { navigateTo } from '../navigationUtils'
3738
import { Heading } from '../Heading'
3839
import { Description } from '../Description'
3940
import { ColorSwatch } from '../ColorSwatch'
@@ -326,7 +327,13 @@ type ThemeState = { showColors: boolean }
326327
<Alert variant="info" margin="0 0 medium">
327328
This theme is used by <strong>InstUI v11.6</strong> components. For
328329
v11.7 and later, use the{' '}
329-
<Link href={`#${themeKey.replace('legacy-', '')}`}>
330+
<Link
331+
href={themeKey.replace('legacy-', '')}
332+
onClick={(e) => {
333+
e.preventDefault()
334+
navigateTo(themeKey.replace('legacy-', ''))
335+
}}
336+
>
330337
{themeKey.replace('legacy-', '')}
331338
</Link>{' '}
332339
theme instead.

0 commit comments

Comments
 (0)