-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
style(Message): update docs to the latest standards (#789)
- Loading branch information
1 parent
33073ca
commit c71efa8
Showing
29 changed files
with
210 additions
and
180 deletions.
There are no files selected for viewing
6 changes: 3 additions & 3 deletions
6
...ns/Message/States/MessageHiddenExample.js → ...ns/Message/States/MessageExampleHidden.js
This file contains 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,10 +1,10 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageHiddenExample = () => ( | ||
const MessageExampleHidden = () => ( | ||
<Message hidden> | ||
You can always see me | ||
You can't see me | ||
</Message> | ||
) | ||
|
||
export default MessageHiddenExample | ||
export default MessageExampleHidden |
4 changes: 2 additions & 2 deletions
4
...s/Message/States/MessageVisibleExample.js → ...s/Message/States/MessageExampleVisible.js
This file contains 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,10 +1,10 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageVisibleExample = () => ( | ||
const MessageExampleVisible = () => ( | ||
<Message visible> | ||
You can always see me | ||
</Message> | ||
) | ||
|
||
export default MessageVisibleExample | ||
export default MessageExampleVisible |
This file contains 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,20 @@ | ||
import React from 'react' | ||
import ExampleSection from 'docs/app/Components/ComponentDoc/ExampleSection' | ||
import ComponentExample from 'docs/app/Components/ComponentDoc/ComponentExample' | ||
|
||
const MessageStatesExamples = () => ( | ||
<ExampleSection title='States'> | ||
<ComponentExample | ||
title='Hidden' | ||
description='A message can be hidden.' | ||
examplePath='collections/Message/States/MessageExampleHidden' | ||
/> | ||
<ComponentExample | ||
title='Visible' | ||
description='A message can be set to visible to force itself to be shown.' | ||
examplePath='collections/Message/States/MessageExampleVisible' | ||
/> | ||
</ExampleSection> | ||
) | ||
|
||
export default MessageStatesExamples |
This file contains 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
This file contains 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
4 changes: 2 additions & 2 deletions
4
...s/Message/Types/MessageIconPropExample.js → ...s/Message/Types/MessageExampleIconProp.js
This file contains 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,12 +1,12 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageIconPropExample = () => ( | ||
const MessageExampleIconProp = () => ( | ||
<Message | ||
icon='inbox' | ||
header='Have you heard about our mailing list?' | ||
content='Get the best news in your e-mail every day.' | ||
/> | ||
) | ||
|
||
export default MessageIconPropExample | ||
export default MessageExampleIconProp |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
4 changes: 2 additions & 2 deletions
4
...ssage/Types/MessageMessagePropsExample.js → ...ssage/Types/MessageExampleMessageProps.js
This file contains 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,11 +1,11 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageMessagePropsExample = () => ( | ||
const MessageExampleMessageProps = () => ( | ||
<Message | ||
header='Changes in Service' | ||
content='We updated our privacy policy here to better service our customers. We recommend reviewing the changes.' | ||
/> | ||
) | ||
|
||
export default MessageMessagePropsExample | ||
export default MessageExampleMessageProps |
This file contains 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,53 @@ | ||
import React from 'react' | ||
import { Icon } from 'semantic-ui-react' | ||
import ExampleSection from 'docs/app/Components/ComponentDoc/ExampleSection' | ||
import ComponentExample from 'docs/app/Components/ComponentDoc/ComponentExample' | ||
|
||
const MessageTypesExamples = () => ( | ||
<ExampleSection title='Types'> | ||
<ComponentExample | ||
title='Message' | ||
description='A basic message.' | ||
examplePath='collections/Message/Types/MessageExampleMessage' | ||
/> | ||
<ComponentExample | ||
description='A basic message built with props.' | ||
examplePath='collections/Message/Types/MessageExampleMessageProps' | ||
/> | ||
<ComponentExample | ||
title='List Message' | ||
description='A message with a list.' | ||
examplePath='collections/Message/Types/MessageExampleList' | ||
/> | ||
<ComponentExample | ||
description='Pass array of items to the Message list prop.' | ||
examplePath='collections/Message/Types/MessageExampleListProp' | ||
/> | ||
<ComponentExample | ||
description='Pass an array of items to the MessageList items prop.' | ||
examplePath='collections/Message/Types/MessageExampleListItemsProp' | ||
/> | ||
<ComponentExample | ||
title='Icon Message' | ||
description='A message can contain an icon.' | ||
examplePath='collections/Message/Types/MessageExampleIcon' | ||
/> | ||
<ComponentExample | ||
description='You can pass an Icon name to the Message icon prop.' | ||
examplePath='collections/Message/Types/MessageExampleIconProp' | ||
/> | ||
<ComponentExample | ||
title='Dismissible Block' | ||
description='A message that the user can choose to hide.' | ||
examplePath='collections/Message/Types/MessageExampleDismissibleBlock' | ||
> | ||
<strong> | ||
<Icon name='warning circle' /> | ||
Dismissible blocks do not automatically close. | ||
Use the <code>onDismiss</code> callback to remove the message. | ||
</strong> | ||
</ComponentExample> | ||
</ExampleSection> | ||
) | ||
|
||
export default MessageTypesExamples |
This file contains 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
This file contains 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
4 changes: 2 additions & 2 deletions
4
...ssage/Variations/MessageCompactExample.js → ...ssage/Variations/MessageExampleCompact.js
This file contains 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,10 +1,10 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageCompactExample = () => ( | ||
const MessageExampleCompact = () => ( | ||
<Message compact> | ||
Get all the best inventions in your e-mail every day. Sign up now! | ||
</Message> | ||
) | ||
|
||
export default MessageCompactExample | ||
export default MessageExampleCompact |
4 changes: 2 additions & 2 deletions
4
.../Variations/MessageCompactPropsExample.js → .../Variations/MessageExampleCompactProps.js
This file contains 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,11 +1,11 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageCompactPropsExample = () => ( | ||
const MessageExampleCompactProps = () => ( | ||
<Message | ||
compact | ||
content='Get all the best inventions in your e-mail every day. Sign up now!' | ||
/> | ||
) | ||
|
||
export default MessageCompactPropsExample | ||
export default MessageExampleCompactProps |
This file contains 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
4 changes: 2 additions & 2 deletions
4
...sage/Variations/MessageFloatingExample.js → ...sage/Variations/MessageExampleFloating.js
This file contains 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,10 +1,10 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageFloatingExample = () => ( | ||
const MessageExampleFloating = () => ( | ||
<Message floating> | ||
Way to go! | ||
</Message> | ||
) | ||
|
||
export default MessageFloatingExample | ||
export default MessageExampleFloating |
4 changes: 2 additions & 2 deletions
4
...Variations/MessageFloatingPropsExample.js → ...Variations/MessageExampleFloatingProps.js
This file contains 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,11 +1,11 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageFloatingPropsExample = () => ( | ||
const MessageExampleFloatingProps = () => ( | ||
<Message | ||
floating | ||
content='Way to go!' | ||
/> | ||
) | ||
|
||
export default MessageFloatingPropsExample | ||
export default MessageExampleFloatingProps |
4 changes: 2 additions & 2 deletions
4
.../Message/Variations/MessageInfoExample.js → .../Message/Variations/MessageExampleInfo.js
This file contains 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,11 +1,11 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageInfoExample = () => ( | ||
const MessageExampleInfo = () => ( | ||
<Message info> | ||
<Message.Header>Was this what you wanted?</Message.Header> | ||
<p>Did you know it's been a while?</p> | ||
</Message> | ||
) | ||
|
||
export default MessageInfoExample | ||
export default MessageExampleInfo |
4 changes: 2 additions & 2 deletions
4
...age/Variations/MessageInfoPropsExample.js → ...age/Variations/MessageExampleInfoProps.js
This file contains 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,12 +1,12 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageInfoPropsExample = () => ( | ||
const MessageExampleInfoProps = () => ( | ||
<Message | ||
info | ||
header='Was this what you wanted?' | ||
content="Did you know it's been a while?" | ||
/> | ||
) | ||
|
||
export default MessageInfoPropsExample | ||
export default MessageExampleInfoProps |
4 changes: 2 additions & 2 deletions
4
...sage/Variations/MessageNegativeExample.js → ...sage/Variations/MessageExampleNegative.js
This file contains 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,11 +1,11 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessageNegativeExample = () => ( | ||
const MessageExampleNegative = () => ( | ||
<Message negative> | ||
<Message.Header>We're sorry we can't apply that discount</Message.Header> | ||
<p>That offer has expired</p> | ||
</Message> | ||
) | ||
|
||
export default MessageNegativeExample | ||
export default MessageExampleNegative |
4 changes: 2 additions & 2 deletions
4
...sage/Variations/MessagePositiveExample.js → ...sage/Variations/MessageExamplePositive.js
This file contains 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,11 +1,11 @@ | ||
import React from 'react' | ||
import { Message } from 'semantic-ui-react' | ||
|
||
const MessagePositiveExample = () => ( | ||
const MessageExamplePositive = () => ( | ||
<Message positive> | ||
<Message.Header>You are eligible for a reward</Message.Header> | ||
<p>Go to your <b>special offers</b> page to see now.</p> | ||
</Message> | ||
) | ||
|
||
export default MessagePositiveExample | ||
export default MessageExamplePositive |
This file contains 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
Oops, something went wrong.