Demo Page Refactor Part 1 #5055
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,43 @@ | ||
| import * as React from 'react'; | ||
| import { ActivityItemStatus } from './ActivityItem.checklist'; | ||
| import { ActivityItemBasicExample } from './examples/ActivityItem.Basic.Example'; | ||
| import { ActivityItemPersonaExample } from './examples/ActivityItem.Persona.Example'; | ||
| import { ActivityItemCompactExample } from './examples/ActivityItem.Compact.Example'; | ||
| import { IDemoPageProps } from '../../demo/components/IDemoPageProps'; | ||
| import { DemoPage } from 'office-ui-fabric-react/lib/demo/components/DemoPage'; | ||
|
|
||
| const ActivityItemBasicExampleCode = require('!raw-loader!office-ui-fabric-react/src/components/ActivityItem/examples/ActivityItem.Basic.Example.tsx') as string; | ||
| const ActivityItemPersonaExampleCode = require('!raw-loader!office-ui-fabric-react/src/components/ActivityItem/examples/ActivityItem.Persona.Example.tsx') as string; | ||
| const ActivityItemCompactExampleCode = require('!raw-loader!office-ui-fabric-react/src/components/ActivityItem/examples/ActivityItem.Compact.Example.tsx') as string; | ||
|
|
||
| export const ActivityItemPageProps: IDemoPageProps = { | ||
| title: 'ActivityItem', | ||
| componentName: 'ActivityItem', | ||
| componentUrl: 'https://github.com/OfficeDev/office-ui-fabric-react/tree/master/packages/office-ui-fabric-react/src/components/ActivityItem', | ||
| componentStatus: ActivityItemStatus, | ||
| examples: [ | ||
| { | ||
| title: 'Activity Items with Icons', | ||
| code: ActivityItemBasicExampleCode, | ||
| view: <ActivityItemBasicExample /> | ||
| }, | ||
| { | ||
| title: 'Activity Items with Personas', | ||
| code: ActivityItemPersonaExampleCode, | ||
| view: <ActivityItemPersonaExample /> | ||
| }, | ||
| { | ||
| title: 'Compact Activity Items', | ||
| code: ActivityItemCompactExampleCode, | ||
| view: <ActivityItemCompactExample /> | ||
| } | ||
| ], | ||
| propertiesTablesSources: [require<string>('!raw-loader!office-ui-fabric-react/src/components/ActivityItem/ActivityItem.types.ts')], | ||
| overview: require<string>('!raw-loader!office-ui-fabric-react/src/components/ActivityItem/docs/ActivityItemOverview.md'), | ||
| bestPractices: '', | ||
| dos: require<string>('!raw-loader!office-ui-fabric-react/src/components/ActivityItem/docs/ActivityItemDos.md'), | ||
| donts: require<string>('!raw-loader!office-ui-fabric-react/src/components/ActivityItem/docs/ActivityItemDonts.md'), | ||
| isHeaderVisible: true, | ||
| }; | ||
|
|
||
| export const ActivityItemPage = (props: { isHeaderVisible: boolean }) => (<DemoPage { ...{ ...ActivityItemPageProps, ...props } } />); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import { IDemoPageProps } from './IDemoPageProps'; | ||
| import { ComponentPage, ExampleCard, PropertiesTableSet, PageMarkdown } from '@uifabric/example-app-base'; | ||
| import * as React from 'react'; | ||
| import { ComponentStatus } from 'office-ui-fabric-react/lib/demo/ComponentStatus/ComponentStatus'; | ||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. auto-import keeps giving me non relative stuff |
||
| export function DemoPage(componentPageProps: IDemoPageProps) { | ||
| return ( | ||
| <ComponentPage | ||
| title={ componentPageProps.title } | ||
| componentName={ componentPageProps.componentName } | ||
| componentUrl={ componentPageProps.componentUrl } | ||
| exampleCards={ | ||
| <div> | ||
| { componentPageProps.examples.map(example => ( | ||
| <ExampleCard title={ example.title } code={ example.code } key={ example.title }> | ||
| { example.view } | ||
| </ExampleCard> | ||
| )) } | ||
| </div> | ||
| } | ||
| propertiesTables={ | ||
| <PropertiesTableSet | ||
| sources={ componentPageProps.propertiesTablesSources } | ||
| /> | ||
| } | ||
| overview={ | ||
| <PageMarkdown> | ||
| { componentPageProps.overview } | ||
| </PageMarkdown> | ||
| } | ||
| bestPractices={ | ||
| <PageMarkdown> | ||
| { componentPageProps.bestPractices } | ||
| </PageMarkdown> | ||
| } | ||
| dos={ | ||
| <PageMarkdown> | ||
| { componentPageProps.dos } | ||
| </PageMarkdown> | ||
| } | ||
| donts={ | ||
| <PageMarkdown> | ||
| { componentPageProps.donts } | ||
| </PageMarkdown> | ||
| } | ||
| isHeaderVisible={ componentPageProps.isHeaderVisible } | ||
| componentStatus={ | ||
| <ComponentStatus | ||
| { ...componentPageProps.componentStatus } | ||
| /> | ||
| } | ||
| /> | ||
| ); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import { IComponentStatusProps } from 'office-ui-fabric-react/lib/demo/ComponentStatus/ComponentStatus.types'; | ||
|
|
||
| export interface IDemoPageProps { | ||
| title: string; | ||
| componentName: string; | ||
| componentUrl: string; | ||
| componentStatus: IComponentStatusProps; | ||
| examples: { | ||
| title: string; | ||
| code: string; | ||
| view: JSX.Element; | ||
| }[]; | ||
| propertiesTablesSources: string[]; | ||
| overview: string; | ||
| dos: string; | ||
| donts: string; | ||
| bestPractices: string; | ||
| isHeaderVisible: boolean; | ||
| } | ||
|
Contributor
There was a problem hiding this comment. 2 things:
Contributor
Author
There was a problem hiding this comment. does it matter that this isn't going to be something we document with api documenter tool? |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you mean to do a relative path import from here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I did actually mean to do relative.