Skip to content

chore(JumpLinks): convert examples to TypeScript #7551

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
nicolethoen merged 1 commit into from
Jun 16, 2022
Merged

chore(JumpLinks): convert examples to TypeScript #7551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
75 changes: 6 additions & 69 deletions packages/react-core/src/components/JumpLinks/examples/JumpLinks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,89 +9,26 @@ propComponents: ['JumpLinks', 'JumpLinksItem']
These examples are static because they have no element to scroll spy on that makes sense. Check out the [React demos](./react-demos) to see scroll spying in action!

### Basic
```js
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

<JumpLinks>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
```ts file='./JumpLinksBasic.tsx'
```

### With centered list
```js
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

<JumpLinks isCentered>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
```ts file='./JumpLinksWithCenteredList.tsx'
```

### With label
```js
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

<React.Fragment>
<JumpLinks label="Jump to section">
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
<JumpLinks isCentered label="Jump to section">
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
</React.Fragment>
```ts file='./JumpLinksWithLabel.tsx'
```

### Vertical
```js
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

<JumpLinks isVertical>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
```ts file='./JumpLinksVertical.tsx'
```

### Vertical with label
```js
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

<JumpLinks isVertical label="Jump to section">
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
```ts file='./JumpLinksVerticalWithLabel.tsx'
```

### Expandable vertical with subsection
```js
import React from 'react';
import { JumpLinks, JumpLinksItem, JumpLinksList } from '@patternfly/react-core';

<JumpLinks isVertical label="Jump to section" expandable={{ default: 'expandable' }}>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem>
Section with active subsection
<JumpLinksList>
<JumpLinksItem isActive>Active subsection</JumpLinksItem>
<JumpLinksItem>Inactive subsection</JumpLinksItem>
<JumpLinksItem>Inactive subsection</JumpLinksItem>
</JumpLinksList>
</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
```ts file='./JumpLinksExpandableVerticalWithSubsection.tsx'
```

10 changes: 10 additions & 0 deletions packages/react-core/src/components/JumpLinks/examples/JumpLinksBasic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

export const JumpLinksBasic: React.FunctionComponent = () => (
<JumpLinks>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
);
18 changes: 18 additions & 0 deletions ...eact-core/src/components/JumpLinks/examples/JumpLinksExpandableVerticalWithSubsection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import React from 'react';
import { JumpLinks, JumpLinksItem, JumpLinksList } from '@patternfly/react-core';

export const JumpLinksExpandableVerticalWithSubsection: React.FunctionComponent = () => (
<JumpLinks isVertical label="Jump to section" expandable={{ default: 'expandable' }}>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem>
Section with active subsection
<JumpLinksList>
<JumpLinksItem isActive>Active subsection</JumpLinksItem>
<JumpLinksItem>Inactive subsection</JumpLinksItem>
<JumpLinksItem>Inactive subsection</JumpLinksItem>
</JumpLinksList>
</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
);
10 changes: 10 additions & 0 deletions packages/react-core/src/components/JumpLinks/examples/JumpLinksVertical.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

export const JumpLinksVertical: React.FunctionComponent = () => (
<JumpLinks isVertical>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
);
10 changes: 10 additions & 0 deletions packages/react-core/src/components/JumpLinks/examples/JumpLinksVerticalWithLabel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

export const JumpLinksVerticalWithLabel: React.FunctionComponent = () => (
<JumpLinks isVertical label="Jump to section">
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
);
10 changes: 10 additions & 0 deletions packages/react-core/src/components/JumpLinks/examples/JumpLinksWithCenteredList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

export const JumpLinksWithCenteredList: React.FunctionComponent = () => (
<JumpLinks isCentered>
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
);
17 changes: 17 additions & 0 deletions packages/react-core/src/components/JumpLinks/examples/JumpLinksWithLabel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import React from 'react';
import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';

export const JumpLinksWithLabel: React.FunctionComponent = () => (
<>
<JumpLinks label="Jump to section">
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
<JumpLinks isCentered label="Jump to section">
<JumpLinksItem>Inactive section</JumpLinksItem>
<JumpLinksItem isActive>Active section</JumpLinksItem>
<JumpLinksItem>Inactive section</JumpLinksItem>
</JumpLinks>
</>
);