Theming Section for Individual Widgets #144
Conversation
|
We used to have sample markup in this section: Do we not want that anymore? |
|
We discussed this in IRC the other week and we didn't want to show full markup. Showing the hierarchy might be nice, but showing the full generated markup is overkill. Showing the markup has also been a cause of confusion, even when accompanied by a note that says you are not supposed to render this yourself. |
|
I agree that the full markup is potentially confusing, regardless of disclaimers. Showing the hierarchy without showing the full markup is kind of tricky. Maybe something like this?
I think the main intention here is to show users a quick list of the classes the widget uses so they know what's available. If they're doing anything non-trivial they're going to head into the dev tools of their choice anyways. |
|
The nested list looks good to me. |
|
Looks good to me too. |
|
@scottgonzalez / @jzaefferer if either of you want to take a look at these they should be good to go. |
|
|
||
| <ul> | ||
| <li><code>ui-autocomplete</code>: The menu used to display matches to the user.</li> | ||
| <li><code>ui-autocomplete-input</code>: The autocomplete's <code><input></code> element.</li> |
There was a problem hiding this comment.
Technically, this isn't always an <input>. It can be an <input>, <textarea> or anything with @contenteditable.
There was a problem hiding this comment.
I changed it to just "input element" since "input" and "input element" already appear a whole lot of autocomplete's API page. And I think it makes sense too; it is the element you're inputting into.
I put a sentence at the beginning because the textarea or contenteditable information is not mentioned anywhere currently.
|
This looks pretty good to me. Is it worth somehow indicating which element is the "main" element (the one the user instantiated the widget from)? |
| <xi:include href="../includes/widget-theming.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/> | ||
|
|
||
| <ul> | ||
| <li><code>ui-autocomplete</code>: The menu used to display matches to the user.</li> |
There was a problem hiding this comment.
Link to the Menu widget's theming section here?
There was a problem hiding this comment.
Good idea; let's add that.
|
Found a few missing things, unless those were intentionally not documented. Otherwise looking good. |
|
@jzaefferer Did you just skim this? Almost everything you mention is already documented, just not in its own bullet points. |
|
Yeah, looks like I did. I deleted those comments. Just three left now. |
|
@scottgonzalez For the "main" elements note I added a clarification for the situations that I believe are not intuitive tjvantoll@9517b68. I was torn about adding that note to the other widgets. |
|
@scottgonzalez @jzaefferer I believe I've covered everything noted. Let me know if you notice anything else otherwise I'll squash and merge this tomorrow night. |
|
👍 |
|
Awesome. Let's land it. |
|
Landed in 7a2b894. |
I want to get these all out there before moving forward, but I thought I'd open a pull request to show where I'm at.