-
Notifications
You must be signed in to change notification settings - Fork 842
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.
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
[Storybook] Add playground stories for remaining C components #7467
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
ea9f71a
Enhance EuiComboBox playground
cee-chen b89dbbf
Enhance EuiCollapsibleNav + fix types
cee-chen a21206a
Add/update comment stories
cee-chen 7f60c87
Remove top-level `EuiCommentTimeline` subcomponent export
cee-chen ee5cbcb
Add context menu stories
cee-chen 7e5c357
Add EuiContext story
cee-chen f30bda5
changelog
cee-chen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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,3 @@ | ||
**Deprecations** | ||
|
||
- Remove unused public `EuiCommentTimeline` subcomponent export. Use the parent `EuiComment` or `EuiCommentList` components instead. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
* in compliance with, at your election, the Elastic License 2.0 or the Server | ||
* Side Public License, v 1. | ||
*/ | ||
|
||
import React from 'react'; | ||
import type { Meta, StoryObj } from '@storybook/react'; | ||
|
||
import { EuiButtonIcon } from '../button'; | ||
|
||
import { EuiComment, EuiCommentProps } from './comment'; | ||
|
||
/** | ||
* Shared comment story utils/arg types | ||
*/ | ||
|
||
export const _eventColorArgType = { | ||
options: [ | ||
undefined, | ||
'subdued', | ||
'transparent', | ||
'plain', | ||
'warning', | ||
'danger', | ||
'success', | ||
'primary', | ||
'accent', | ||
], | ||
control: { type: 'radio' }, | ||
}; | ||
export const _actionsExampleArgType = { | ||
control: 'radio', | ||
options: ['Example action', 'No actions'], | ||
mapping: { | ||
'Example action': ( | ||
<EuiButtonIcon | ||
title="Custom action" | ||
aria-label="Custom action" | ||
color="text" | ||
iconType="copy" | ||
/> | ||
), | ||
'No actions': null, | ||
}, | ||
defaultValue: 'Example action', | ||
}; | ||
|
||
/** | ||
* Rendered stories | ||
*/ | ||
|
||
const meta: Meta<EuiCommentProps> = { | ||
title: 'EuiComment', | ||
component: EuiComment, | ||
argTypes: { | ||
eventColor: _eventColorArgType, | ||
actions: _actionsExampleArgType, | ||
}, | ||
excludeStories: /^_/, // Do not render the shared argTypes as stories | ||
}; | ||
|
||
export default meta; | ||
type Story = StoryObj<EuiCommentProps>; | ||
|
||
export const Playground: Story = { | ||
args: { | ||
username: 'User', | ||
timelineAvatar: 'user', | ||
event: 'posted', | ||
eventIcon: 'pencil', | ||
timestamp: 'on Jan 1, 2020', | ||
actions: 'Example action', | ||
children: 'A user message or any custom component', | ||
}, | ||
}; |
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.
Oops, something went wrong.
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.
Would this be better as
text
?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.
Personally, I don't think so. IMO, it's confusing/not a good example of what a consumer would actually pass to the
button
prop, which would be something like:button={<EuiButton onClick={toggleCollapsibleNav} />}
. The controls should try to provide code examples for consumers if possible, and setting this to a string would indicate a button automagically renders if they passbutton="Open me"
, which is not the case.