Skip to content

Add components examples in README.md files - Part 2#8338

Merged
gziolo merged 42 commits into
WordPress:masterfrom
mmtr:update/components-examples
Aug 8, 2018
Merged

Add components examples in README.md files - Part 2#8338
gziolo merged 42 commits into
WordPress:masterfrom
mmtr:update/components-examples

Conversation

@mmtr

@mmtr mmtr commented Jul 31, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor

This continues #8267

The aim of this PR is to include working examples in the components documentation.

Components (Part 2)

  • HigherOrder
  • Modal
  • NavigableContainer
  • Notice
  • Panel
  • Placeholder
  • Popover
  • QueryControls
  • RadioControl
  • RangeControl
  • ResponsiveWrapper
  • Sandbox
  • ScrollLock
  • SelectControl
  • ServerSideRender
  • SlotFill
  • Spinner
  • TabPanel
  • TextControl
  • TextAreaControl
  • ToggleControl
  • Toolbar
  • Tooltip
  • TreeSelect

@mmtr mmtr mentioned this pull request Jul 31, 2018
Merged
26 tasks
@gziolo gziolo mentioned this pull request Aug 1, 2018
Merged
4 tasks
@mmtr

mmtr commented Aug 3, 2018

Copy link
Copy Markdown
Contributor Author

@gziolo I've started to define a MyComponent component name for the examples, so Calypso can run them dynamically using the render function of react-live as suggested here. Does this look good to you?

@mmtr

mmtr commented Aug 4, 2018

Copy link
Copy Markdown
Contributor Author

I don't think we should expose ServerSideRender in Calypso. It requires a /gutenberg/v1/block-renderer/:block API endpoint.

@gziolo

gziolo commented Aug 4, 2018

Copy link
Copy Markdown
Member

@mmtr - whatever works in terms of the name. My only concern would be the need to document it somewhere so we could point contributors to a link which explains how examples should be structured to ensure we can consume them from docs.

ServerSideRenderer probably should be moved to the editor or standalone package, @youknowriad any thoughts on that? This is similar to CodeEditor tied to WordPress instance.

@mmtr mmtr changed the title [WIP] Add components examples in README.md files - Part 2 Add components examples in README.md files - Part 2 Aug 5, 2018
@mmtr

mmtr commented Aug 5, 2018

Copy link
Copy Markdown
Contributor Author

@gziolo this should be ready to review 🎉

This was referenced Aug 5, 2018
Merged
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
gziolo
gziolo approved these changes Aug 6, 2018
View reviewed changes

@gziolo gziolo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had only one comment. I haven't tested code examples as it would be too time-consuming. Let's move forward and open a follow-up when we discover any issues. Those are only docs after all 😃

I had one question where I think we should skip providing props to the example component.

Comment thread packages/components/src/higher-order/with-api-data/README.md Outdated

@gziolo gziolo Aug 6, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI: We are deprecating this one: #8584.

@mmtr mmtr Aug 6, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! I won't include it then in Calypso

Comment thread packages/components/src/higher-order/with-context/README.md Outdated

@gziolo gziolo Aug 6, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are deprecating this one, too: #8189.

@mmtr mmtr Aug 6, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one example less to include in Calypso

Comment thread packages/components/src/modal/README.md Outdated

@gziolo gziolo Aug 6, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much shorter 👍

Comment thread packages/components/src/server-side-render/README.md Outdated

@gziolo gziolo Aug 6, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it provide some dummy attributes to make it work without any attributes provided?

@mmtr mmtr Aug 6, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, it makes sense. I forgot this one because it's not being included in Calypso.

mmtr added 23 commits August 6, 2018 21:59
@mmtr
Components examples: Spinner
f52ff8d
@mmtr
Components examples: TabPanel
7cf6f08
@mmtr
Components examples: TextControl
b541266
@mmtr
Components examples: TextareaControl
81ef947
@mmtr
Components examples: ToggleControl
5984848
@mmtr
Components examples: Toolbar
aacb094
@mmtr
Components examples: Tooltip
2a75f76
@mmtr
Components examples: TreeSelect
cb4d859
@mmtr
Components examples: NavigableContainer
a0aca61
@mmtr
Components examples: navigateRegions
e7f85bb
@mmtr
Components examples: withConstrainedTabbing
6bc6fbc
@mmtr
Components examples: withContext
2b7c999
@mmtr
Components examples: withFallbackStyles
4c387ce
@mmtr
Components examples: withFilters
9394810
@mmtr
Components examples: withFocusOutside
0b0bba5
@mmtr
Components examples: withFocusReturn
8d5c451
@mmtr
Components examples: withNotices
ed573aa
@mmtr
Components examples: withSpokenMessages
9a94a5b
@mmtr
Components examples: withAPIData
89f0c1b
@mmtr
Contributing guidelines for the components
5471769
@mmtr
Contributing guidelines for the components
c2e20b0
@mmtr
Contributing guidelines for the components
1d93a3b
@mmtr
Add dummy attributes to ServerSideRender example
33cbfae
@gziolo gziolo merged commit 5b81cbc into WordPress:master Aug 8, 2018
@gziolo gziolo added this to the 3.5 milestone Aug 8, 2018
@gziolo gziolo added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components labels Aug 8, 2018
@mmtr mmtr deleted the update/components-examples branch August 9, 2018 21:06
This was referenced Aug 11, 2018
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gziolo gziolo gziolo approved these changes

Assignees

No one assigned

Labels

[Package] Components /packages/components [Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

3.5

Development

Successfully merging this pull request may close these issues.

2 participants

@mmtr @gziolo