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

Drawer padding property confusing/conflicting name #1383

Closed
Hugos68 opened this issue Apr 26, 2023 · 1 comment · Fixed by #1389
Closed

Drawer padding property confusing/conflicting name #1383

Hugos68 opened this issue Apr 26, 2023 · 1 comment · Fixed by #1389
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@Hugos68
Copy link
Contributor

Hugos68 commented Apr 26, 2023

Current Behavior

The padding property in any DrawerSettings object will affect the backdrop and not the drawer itself.

Reproduction / Steps To Reproduce

  1. Create a DrawerSettings object
  2. Set padding to any value (as long as its visible to the naked eye (2, 4, 8 etc)
  3. Watch is being applied to backdrop.

Anything else?

I'd highly recommend to change padding to paddingBackdrop to be in line with the names of other backdrop properties and possibly even add the padding property for the drawer itself aswell.

@Hugos68 Hugos68 added the bug Something isn't working label Apr 26, 2023
@endigo9740
Copy link
Contributor

endigo9740 commented Apr 26, 2023

We have a naming style convention where we try to avoid using two word camel-case prop names when we can avoid it. I think for now we just need to adjust the JSDoc comment to indicate this is a Backdrop prop instead of a Drawer prop.

https://github.com/skeletonlabs/skeleton/blob/dev/src/lib/utilities/Drawer/Drawer.svelte#L32

Renaming the prop would be a breaking change, which we can't implement trivially.

@endigo9740 endigo9740 added the documentation Improvements or additions to documentation label Apr 26, 2023
@endigo9740 endigo9740 linked a pull request Apr 27, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants