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

Improve events and documentation #389

Closed
endigo9740 opened this issue Oct 16, 2022 · 4 comments · Fixed by #708
Closed

Improve events and documentation #389

endigo9740 opened this issue Oct 16, 2022 · 4 comments · Fixed by #708
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@endigo9740
Copy link
Contributor

endigo9740 commented Oct 16, 2022

Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!

This will be a larger scale audit and update, but most components include little to no event bubbling (reading: passing the event up to the component definition). This leaves users to guess or review the source code to know what events are present and available.

The new doc format provides a dedicated tab for Events, so we should look to update each component and document accordingly.

What type of pull request would this be?

Documentation

Any links to similar examples or other references we should review?

The SlideToggle component is one that has a lot of events set to bubble. By tapping the Label element the expected event bubbles. Unfortunately these events not currently documented, which illustrates my point.

@endigo9740 endigo9740 added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed feature request Request a feature or introduce and update to the project. labels Oct 16, 2022
@endigo9740 endigo9740 changed the title Improve event bubbling for all components Improve event bubbling and documentation Oct 16, 2022
@endigo9740 endigo9740 pinned this issue Oct 18, 2022
@endigo9740 endigo9740 unpinned this issue Oct 19, 2022
@endigo9740 endigo9740 changed the title Improve event bubbling and documentation Improve event forwarding and documentation Oct 21, 2022
@endigo9740
Copy link
Contributor Author

endigo9740 commented Oct 21, 2022

Given Sveld can handle events, this should occur after the auto-doc updates. New forwarding events will still need to be selectively applied to components though.

@endigo9740 endigo9740 added this to the v1.0 milestone Nov 16, 2022
@endigo9740 endigo9740 removed the feature request Request a feature or introduce and update to the project. label Nov 16, 2022
@endigo9740
Copy link
Contributor Author

Stepper: add on:next event. Document missing on:complete event

@Moosieus
Copy link

Moosieus commented Dec 15, 2022

Paginator component's on:amount event doesn't emit the proper amount/page size. To reproduce:

  1. Go to https://www.skeleton.dev/components/paginators
  2. Inspect element anywhere on page and open the JavaScript console
  3. Toggle the example paginator's amount
  4. Note the resulting log statement always prints 0 instead of the proper page size

@endigo9740 endigo9740 removed the help wanted Extra attention is needed label Dec 16, 2022
@endigo9740 endigo9740 self-assigned this Dec 16, 2022
@endigo9740 endigo9740 changed the title Improve event forwarding and documentation Improve events and documentation Dec 16, 2022
@endigo9740
Copy link
Contributor Author

@Moosieus the reported issue will be resolved as part of the incoming PR. Very simple to fix, just wasn't passing the correct data point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants