This repository has been archived by the owner on Jul 12, 2020. It is now read-only.
Support custom boxes #26
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
acjh
suggested changes
May 21, 2018
docs/example/tipBoxDocs.vue
Outdated
| @@ -1,5 +1,6 @@ | |||
| <template> | |||
| <doc-section id="tipBoxDocs" name="TipBox"> | |||
| <p>Alternative alias: box</p> | |||
docs/example/tipBoxDocs.vue
Outdated
| </tip-box> | ||
| <box background-color="white" border-color="grey" border-left-color="blue"> | ||
| empty box with left border | ||
| </box> |
There was a problem hiding this comment.
- Let's move these into a separate
<div class="bs-example"></div><doc-code></doc-code>group.
At the moment, we need to scroll to see the doc-code. - Two examples are sufficient: empty box (demo colours), info rocket (demo icon)
- Both can use
<box>. - Customise
type=defaultbeforetype=info. - Be descriptive:
empty box with left bordershould bedefault, styled as empty box with blue left border,info but with rocketshould beinfo, with rocket icon,
docs/example/tipBoxDocs.vue
Outdated
| </doc-code> | ||
| <doc-table name="TipBox Options"> | ||
| <div> | ||
| <p>backgroundColor</p> |
docs/example/tipBoxDocs.vue
Outdated
| </div> | ||
| <div> | ||
| <p>type</p> | ||
| <p><code>String</code>, one of <code>warning</code>, <code>info</code>, <code>definition</code>, <code>success</code>, <code>tip</code>, <code>important</code>, <code>wrong</code>, or empty for default.</p> |
There was a problem hiding this comment.
- Use the same order as examples ("or empty for default." can remain at the end).
- Considering the length, let's move this to Description (as done in Panel Options).
docs/example/tipBoxDocs.vue
Outdated
| <p>borderLeftColor</p> | ||
| <p><code>String</code></p> | ||
| <p><code>null</code></p> | ||
| <p>Color of the left border.</p> |
There was a problem hiding this comment.
Leave description blank unless it adds value.
- Change this to "Overrides `border-color` for the left border."
- Also keep for
color.
|
@acjh thanks for the reviews! |
acjh
suggested changes
May 21, 2018
docs/example/tipBoxDocs.vue
Outdated
| info, with rocket icon | ||
| </box> | ||
| </doc-code> | ||
| <doc-table name="TipBox Options"> |
There was a problem hiding this comment.
Just "TipBox", otherwise it becomes "TipBox Options Options".
docs/example/tipBoxDocs.vue
Outdated
| <p>border-left-color</p> | ||
| <p><code>String</code></p> | ||
| <p><code>null</code></p> | ||
| <p>Overrides `border-color` for the left border.</p> |
There was a problem hiding this comment.
Should be <code>border-color</code>.
But let's just remove the backticks, to be consistent with Panel Option's "no-switch" reference.
docs/example/tipBoxDocs.vue
Outdated
| @@ -52,6 +53,60 @@ | |||
| definition | |||
| </tip-box> | |||
| </doc-code> | |||
| <div class="bs-example"> | |||
There was a problem hiding this comment.
Add a heading:
<br>
<h4>Custom boxes</h4>|
Changes made. |
acjh
approved these changes
May 22, 2018
acjh
reviewed
May 23, 2018
src/index.js
Outdated
| @@ -30,6 +31,7 @@ const components = { | |||
| accordion, | |||
| affix, | |||
| aside, | |||
| box, | |||
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [X] Enhancement to an existing feature
Fixes MarkBind/markbind#69
Fixes MarkBind/markbind#62
What is the rationale for this request?
tip-box. (You can useboxinstead oftip-box).What changes did you make? (Give an overview)
Added new attributes
color,background-color,icon,border-colorfor tip-box customization. Also added a new attributeborder-left-colorto support empty-fill type tip boxes.Provide some example code that this change will affect:
Is there anything you'd like reviewers to focus on?
Documentation wordings.
Testing instructions:
The documentation provides the code under the tip-box section, can use that web page to experiment with the new attributes shown in the documentation.