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

A hope #348

Open
ExecutableBug opened this issue Sep 25, 2020 · 6 comments
Open

A hope #348

ExecutableBug opened this issue Sep 25, 2020 · 6 comments

Comments

@ExecutableBug
Copy link

@ExecutableBug ExecutableBug commented Sep 25, 2020

I hope that all component reference docs indicates the name of component for referencing at the header, just like Vant:
image

Thanks a lot.

@zazzaz
Copy link
Collaborator

@zazzaz zazzaz commented Sep 25, 2020

Will take this into consideration, thanks.

@JeremyWuuuuu
Copy link
Collaborator

@JeremyWuuuuu JeremyWuuuuu commented Sep 25, 2020

Nice suggestion, I think this is kind of necessary for the documentation.

@ArishSultan
Copy link

@ArishSultan ArishSultan commented Sep 27, 2020

I want to work on this issue, can someone just elaborate what the problem is? I didn't understand the issue

@JeremyWuuuuu
Copy link
Collaborator

@JeremyWuuuuu JeremyWuuuuu commented Sep 27, 2020

@ArishSultan
Well, this is essentially an enhancement for the documentation, which @ExecutableBug would like documentations to have a code fragment for how to get the component from the bundle like this

import { createApp } from 'vue'
import { ComponentInstaller } from '@element-plus'
import yourAppHere from 'path/to/your/app/entrance'

const app = createApp(yourAppHere)
app.use(ComponentInstaller)
@zazzaz
Copy link
Collaborator

@zazzaz zazzaz commented Sep 27, 2020

in more detail, it will be better to tell our user what component to import to make the demo work.

<template>
  <el-radio v-model="radio" label="1">A</el-radio>
  <el-radio v-model="radio" label="2">B</el-radio>
</template>

<script>
 import { ElRadio } from '@element-plus'

  export default {
    data () {
      return {
        radio: '1'
      };
    }
  }
</script>
@ExecutableBug
Copy link
Author

@ExecutableBug ExecutableBug commented Sep 27, 2020

@ArishSultan yep, just like what @JeremyWuuuuu and @zazzaz said, and i am sorry for my description, i am working hard on my english

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.