Port @uppy/drop-target docs
#59
Conversation
|
There was a problem hiding this comment.
Nice, thanks.
Some changes still needed:
- It's missing the "When should I use it? section
- Code sample is not under first heading but under "Use"
- "Use" doesn't have a "CSS" section, instead if shows the plugin in context of other plugins with highlighting and
showLineNumbers. Checkout some of the "Sources" plugins for examples. - "Options" doesn't show a code overview of the options. We have Generate table of contents under "Options" heading for all docs #45 for that.
- Options do not show default values in the heading
- The tip admonition for examples doesn't exist. The codesandbox link is also incorrect
| [Try out the live example](/examples) or take it for a spin in | ||
| [CodeSandbox](https://codesandbox.io/s/uppy-drag-drop-gyewzx?file=/src/index.js). |
There was a problem hiding this comment.
/examples doesn't exit. We should also create a codesandbox for this plugin and link it here.
There was a problem hiding this comment.
We plan to have something at /examples don't we?
Line 58 in 0f9e149
There was a problem hiding this comment.
No as discussed we will go live without it and potentially never have it as we emphasize our existing examples repo and codesandboxes. So at least for now we need to remove it.
There was a problem hiding this comment.
We should also create a codesandbox for this plugin and link it here.
I don't know what's needed for this. We should probably document some guidelines around it.
No as discussed we will go live without it and potentially never have it as we emphasize our existing examples repo and codesandboxes.
There are 12 other pages linking to /examples, plus the main nav menu cited above. I don't think it makes sense to remove it from this PR. If we plan to remove them before going live, it can be done in a follow-up PR and doesn't have to block this one.
| #### `target` | ||
|
|
||
| DOM element, CSS selector, or plugin to place the drag and drop area into | ||
| (`string`, `Element`, `Function`, or `UIPlugin`, default: `null`). |
There was a problem hiding this comment.
I think we always put id and target on top of the list
There was a problem hiding this comment.
Shouldn't we list the option in alphabetical order instead? That seems easier to enforce.
There was a problem hiding this comment.
It's a bit all over the place currently. I can make sorting part of #45 (automate it with remark). So indeed doesn't matter that much for now
Co-authored-by: Merlijn Vos <[email protected]>
|
|
||
| ### Options | ||
|
|
||
| #### `onDragLeave(event)` |
There was a problem hiding this comment.
Do we want to leave the function name with arguments, so URLs won’t break if we change the arguments? https://transloadit.slack.com/archives/C0FMW9PSB/p1673972430908959
Co-authored-by: Artur Paikin <[email protected]>
No description provided.