Doc: Improve MarkdownInput documentation #9511
Merged
Conversation
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
arimet
force-pushed
the
doc/markdown-input
branch
from
ab5a65c to
5747b3a
Compare
djhi
approved these changes
Dec 12, 2023
djhi
approved these changes
Dec 12, 2023
adguernier
requested changes
Dec 13, 2023
fzaninotto
requested changes
Dec 13, 2023
arimet
force-pushed
the
doc/markdown-input
branch
from
8c5ad56 to
618fd68
Compare
adguernier
requested changes
Dec 14, 2023
arimet
force-pushed
the
doc/markdown-input
branch
from
618fd68 to
2d58140
Compare
djhi
reviewed
Dec 18, 2023
docs/MarkdownInput.md
Outdated
Comment on lines
181
to
216
| function createLastButton() { | ||
| const button = document.createElement('button'); | ||
| button.className = 'toastui-editor-toolbar-icons last'; | ||
| button.style.backgroundImage = 'none'; | ||
| button.style.margin = '0'; | ||
| button.style.width = '100%'; | ||
| button.innerHTML = `<i>Custom Button</i>`; | ||
| button.addEventListener('click', () => { | ||
| alert('Custom Button action'); | ||
| }); | ||
|
|
||
| return button; | ||
| } | ||
|
|
||
| return ( | ||
| <SimpleForm> | ||
| <MarkdownInput | ||
| source="description" | ||
| toolbarItems={[ | ||
| ['heading', 'bold', 'italic', 'strike'], | ||
| [ | ||
| { | ||
| el: createLastButton(), | ||
| tooltip: 'Custom Command', | ||
| name: 'custom', | ||
| }, | ||
| ], | ||
| ]} | ||
| /> | ||
| </SimpleForm> | ||
| ); |
There was a problem hiding this comment.
Can you complete this example? Imports, real component, etc.
arimet
force-pushed
the
doc/markdown-input
branch
from
2d58140 to
dabcc5b
Compare
fzaninotto
requested changes
Dec 19, 2023
adguernier
approved these changes
Dec 20, 2023
fzaninotto
approved these changes
Dec 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
The documentation for MarkdownInput is short and doesn't show the power of that component.
https://marmelab.com/react-admin/MarkdownInput.html
Solution
Expand it