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

tip-box is not documented and can be deprecated #1804

Closed
jovyntls opened this issue Mar 6, 2022 · 2 comments · Fixed by #2121
Closed

tip-box is not documented and can be deprecated #1804

jovyntls opened this issue Mar 6, 2022 · 2 comments · Fixed by #2121

Comments

@jovyntls
Copy link
Contributor

jovyntls commented Mar 6, 2022

Is your request related to a problem?
MarkBind currently supports using both <tip-box>...</tip-box> and <box>...</box> used to make boxes.
tip-box is not documented, but is used in multiple places in our docs. Both support the same attributes and have the same behaviour. I think this is caused by vue-components registering both box: tipBox and tipBox as components:
Screenshot 2022-03-06 at 8 21 39 PM

Describe the solution you'd like

Since box is documented and more widely used, we could deprecate tip-box by

  • Keeping only box: tipBox in vue-components/src/index.js
  • Change all usages of tip-box to box

Describe alternatives you've considered

Alternatively, we could document tip-box and officially support it, but I think it may be confusing and unnecessary to have two different names for the same component.

@tlylt
Copy link
Contributor

tlylt commented Mar 6, 2022

Looks like it was initially mentioned that box is an alias for tip-box in this PR. Seems like it was removed when the docs were updated later on here.

image

@jonahtanjz
Copy link
Contributor

Alternatively, we could document tip-box and officially support it, but I think it may be confusing and unnecessary to have two different names for the same component.

Agree with this, I think it's better to remove tip-box altogether.

@itsyme itsyme self-assigned this Jan 30, 2023
@itsyme itsyme mentioned this issue Jan 30, 2023
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants