Skip to content

Rename stickyTop->offsetHeader and improve docs #2262

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

Merged
merged 13 commits into from
Sep 5, 2022

Conversation

broccolinisoup
Copy link
Member

@broccolinisoup broccolinisoup commented Aug 24, 2022

Renaming stickyTop to offsetHeader suggested by @siddharthkp .

@colebemis @siddharthkp Just creating a PR to get the feeling with the improved docs. Let me know what you think

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge
  • Add a changeset

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@broccolinisoup broccolinisoup added docs Documentation react labels Aug 24, 2022
@broccolinisoup broccolinisoup requested review from a team and mperrotti August 24, 2022 08:12
@changeset-bot
Copy link

changeset-bot bot commented Aug 24, 2022

🦋 Changeset detected

Latest commit: 4564242

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@broccolinisoup broccolinisoup marked this pull request as draft August 24, 2022 08:12
@github-actions
Copy link
Contributor

github-actions bot commented Aug 24, 2022

size-limit report 📦

Path Size
dist/browser.esm.js 76.29 KB (+0.01% 🔺)
dist/browser.umd.js 76.9 KB (+0.01% 🔺)

@broccolinisoup broccolinisoup marked this pull request as ready for review August 24, 2022 08:17
@broccolinisoup broccolinisoup temporarily deployed to github-pages August 24, 2022 08:23 Inactive
@broccolinisoup broccolinisoup temporarily deployed to github-pages August 26, 2022 01:38 Inactive
type="number | string"
defaultValue="0"
description="Use stickyTop to push the sticky pane down to make room for a sticky header if necessary. Use the type `string` to specify the height with a unit i.e. 5rem; otherwise the type `number` will be taken as px."
description="Use offsetTop along with the sticky prop to push the sticky pane down to make room for a sticky header if necessary. Use the type `string` to specify the height with a unit i.e. 5rem; otherwise the type `number` will be taken as px."
Copy link
Member

Choose a reason for hiding this comment

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

nice!

Copy link
Member

@siddharthkp siddharthkp left a comment

Choose a reason for hiding this comment

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

Implementation looks good!

Would be nice to sneak this in without a major version update

@colebemis colebemis temporarily deployed to github-pages August 26, 2022 20:05 Inactive
@broccolinisoup broccolinisoup temporarily deployed to github-pages August 29, 2022 07:58 Inactive
@broccolinisoup broccolinisoup changed the title Rename stickyTop->offsetTop and improve docs Rename stickyTop->offsetHeader and improve docs Aug 29, 2022
Copy link
Member

@siddharthkp siddharthkp left a comment

Choose a reason for hiding this comment

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

yay!

@broccolinisoup broccolinisoup temporarily deployed to github-pages August 29, 2022 08:20 Inactive
@broccolinisoup broccolinisoup temporarily deployed to github-pages August 30, 2022 20:48 Inactive
@broccolinisoup broccolinisoup temporarily deployed to github-pages September 2, 2022 23:30 Inactive
@broccolinisoup broccolinisoup temporarily deployed to github-pages September 5, 2022 08:33 Inactive
@siddharthkp siddharthkp temporarily deployed to github-pages September 5, 2022 08:43 Inactive
@broccolinisoup broccolinisoup temporarily deployed to github-pages September 5, 2022 09:06 Inactive
@broccolinisoup broccolinisoup temporarily deployed to github-pages September 5, 2022 10:25 Inactive
@broccolinisoup broccolinisoup merged commit 3ec0c9d into main Sep 5, 2022
@broccolinisoup broccolinisoup deleted the broccolinisoup/stickyTop-naming-options branch September 5, 2022 10:30
@primer-css primer-css mentioned this pull request Sep 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation react
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants