Skip to content
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

Add technical documentation #25759

Closed
6 of 9 tasks
noisysocks opened this issue Oct 1, 2020 · 3 comments
Closed
6 of 9 tasks

Add technical documentation #25759

noisysocks opened this issue Oct 1, 2020 · 3 comments
Assignees
Labels
[Feature] Widgets Screen The block-based screen that replaced widgets.php. [Type] Developer Documentation Documentation for developers

Comments

@noisysocks
Copy link
Member

noisysocks commented Oct 1, 2020

I'm creating this issue to keep track of all of the technical documentation that needs to be written for the widgets editor which is landing in WordPress 5.6.

Non-technical documentation is generally handled separately by the docs team.

Please feel free to add to this list!


For plugin and theme developers

  • How to opt your theme out of block widgets.
  • How to make it so that your widget doesn't appear in the Legacy Widget block dropdown.
  • How to make it so that your plugin's widget can be converted into your plugin's block.
  • How to add custom UI to the sidebar. See Widgets editor: Add basic options for extensibility #25758.
  • How to add custom UI to the top and bottom of the screen. See Widgets editor: Add basic options for extensibility #25758.
  • How to ensure compatibility with the Legacy Widget block using the widget-added event.
  • How to show "No preview available." message in Legacy Widget block.

For core developers

  • Overview of the screen's architecture. Should live in packages/edit-widgets/README.md.
  • A dev note to go on Make/Core ahead of 5.8.
@noisysocks noisysocks added [Type] Developer Documentation Documentation for developers [Feature] Widgets Screen The block-based screen that replaced widgets.php. [Type] Overview Comprehensive, high level view of an area of focus often with multiple tracking issues labels Oct 1, 2020
@annezazu annezazu added the Needs Dev Note Requires a developer note for a major WordPress release cycle label Oct 1, 2020
@noisysocks noisysocks changed the title Navigation editor: Overview of documentation Widgets editor: Overview of documentation Oct 6, 2020
@annezazu
Copy link
Contributor

Pulling from @justintadlock recent post on the new screen, I wanted to flag a few items he mentioned that aren't referenced here that seem great to address if possible:

  • What are the hooks to add custom styles for the Widgets screen?
  • Can themes target specific sidebar styles on the Widgets screen?
  • Is it possible to consistently style sections like traditional widgets on the front end?
  • Can themes opt into wide and full-alignment within block areas, which could essentially be used similarly to the post content area?

@cguntur cguntur mentioned this issue Oct 14, 2020
17 tasks
@noisysocks noisysocks changed the title Widgets editor: Overview of documentation Widgets editor: Write technical documentation Jan 5, 2021
@noisysocks noisysocks removed the [Type] Overview Comprehensive, high level view of an area of focus often with multiple tracking issues label Jan 5, 2021
@draganescu draganescu changed the title Widgets editor: Write technical documentation Add technical documentation Feb 18, 2021
@skorasaurus
Copy link
Member

For how to opt out #25123

@draganescu
Copy link
Contributor

I am working on a dev note.

@youknowriad youknowriad removed the Needs Dev Note Requires a developer note for a major WordPress release cycle label Jul 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Widgets Screen The block-based screen that replaced widgets.php. [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

5 participants