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

add to each component the module it comes from #180

Merged
merged 2 commits into from
Jun 24, 2019

Conversation

categulario
Copy link
Contributor

The only thing I'm not so sure about is vl-view because it is not directly exported as module but I cannot explain from the source how am I able to use it without importing it explicitly.

Other than that this should close #178.

Doing this I realized it might be a good idea to include a line with Vue.use(Component) as part of every ES6 Module block but I don't know how helpful/confusing that would be.

@categulario
Copy link
Contributor Author

I just realized it might be a better idea for vl-view to just leave a comment like:

// Comes with vl-map

if that's the case.

@coveralls
Copy link

coveralls commented Jun 22, 2019

Coverage Status

Coverage remained the same at 22.172% when pulling c0b7618 on categulario:categulario/docs into 82193d2 on ghettovoice:master.

@ghettovoice
Copy link
Owner

@categulario great job! Thank you.
As for vl-view component: you are right, from the lib root it comes with Map module because Map and View are strongly related things. And they both will be installed with Vue.use(Map) call. So I think how you describe this is enough right now.

Doing this I realized it might be a good idea to include a line with Vue.use(Component) as part of every ES6 Module block but I don't know how helpful/confusing that would be.

Strongly agree with this. Actually using ES6 modules is the recommended way, UMD build should be used for quick testing and examples. So it would be great if you can add to each import example second line with Vue.use statement.

Copy link
Owner

@ghettovoice ghettovoice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Thank you!

@ghettovoice ghettovoice merged commit 89e4930 into ghettovoice:master Jun 24, 2019
@categulario categulario deleted the categulario/docs branch June 24, 2019 13:28
ghettovoice added a commit that referenced this pull request Oct 3, 2019
- resolved #173, #174, #201, #135, #216, #132 #224 #225 #226, #230
- merged of pull requests #160, #175, #180, #185, #188, #191, #206, #208,
  #212, #213, #215, #221, #227, #231
  Thanks to @baspeeters, @sjmallon, @janlazo, @categulario,
  @skymaze, @jemasfox, @owen-thurston, @agmt5989, @RemiDesgrange
- improved property watchers
- optional debug messages
- fixed broken UMD version
- simplified initial interaction/controls setup #95
- added `id` property for all ol components for easy identification
- mixins, ol-ext and rx-ext now are build to single file package,
  imports from those packages are not changed
- UMD version (dev/demo version) now includes all used stuff from `ol`
  package
- updated documentation and README
ghettovoice added a commit that referenced this pull request Oct 3, 2019
- resolved #173, #174, #201, #135, #216, #132 #224 #225 #226, #230
- merged of pull requests #160, #175, #180, #185, #188, #191, #206, #208,
  #212, #213, #215, #221, #227, #231
  Thanks to @baspeeters, @sjmallon, @janlazo, @categulario,
  @skymaze, @jemasfox, @owen-thurston, @agmt5989, @RemiDesgrange
- improved property watchers
- optional debug messages
- fixed broken UMD version
- simplified initial interaction/controls setup #95
- added `id` property for all ol components for easy identification
- mixins, ol-ext and rx-ext now are build to single file package,
  imports from those packages are not changed
- UMD version (dev/demo version) now includes all used stuff from `ol`
  package
- updated documentation and README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add to docs the module name of every component
3 participants