{"id":26781680,"url":"https://github.com/pixelunion/bc-scroll-link","last_synced_at":"2025-03-29T08:17:31.931Z","repository":{"id":44075307,"uuid":"132650245","full_name":"pixelunion/bc-scroll-link","owner":"pixelunion","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-05T22:23:08.000Z","size":552,"stargazers_count":0,"open_issues_count":11,"forks_count":0,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-03-26T12:58:30.008Z","etag":null,"topics":["library"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pixelunion.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-08T18:40:56.000Z","updated_at":"2021-05-21T15:35:00.000Z","dependencies_parsed_at":"2023-02-04T20:32:23.713Z","dependency_job_id":null,"html_url":"https://github.com/pixelunion/bc-scroll-link","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelunion%2Fbc-scroll-link","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelunion%2Fbc-scroll-link/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelunion%2Fbc-scroll-link/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelunion%2Fbc-scroll-link/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pixelunion","download_url":"https://codeload.github.com/pixelunion/bc-scroll-link/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246156411,"owners_count":20732397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library"],"created_at":"2025-03-29T08:17:31.423Z","updated_at":"2025-03-29T08:17:31.918Z","avatar_url":"https://github.com/pixelunion.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bigcommerce Scroll Link Module\n\nScroll to the top or any ID / class\n\n### Installation\n\n```\nnpm i --save github:pixelunion/bc-scroll-link\n```\n\n### Usage\n\n```\nimport $ from 'jquery';\nimport ScrollLink from 'bc-scroll-link';\n\nnew ScrollLink({\n  duration: 1000,\n  easing: 'swing'\n});\n```\n\n### Options\n\n\n`duration`: \nthe scroll duration in milliseconds.\n\n`easing`: \neasing (only 'swing' and 'linear' available by default).\n\n`delay`: delay before scrolling.\n\n`updateHash`: (defaults to `true`) add the target to the URL? Set to `false` if targeting classes instead of IDs.\n\n### Methods\n`scrollToContent(target)`: Scroll to a target without using an anchor / button.\n\n### Some sample markup\n\n```\n\u003cbutton data-scroll=\"#\"\u003eTop\u003c/button\u003e\n\n\u003cbutton data-scroll=\"#some-section\"\u003eJump to: Some Section\u003c/button\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelunion%2Fbc-scroll-link","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpixelunion%2Fbc-scroll-link","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelunion%2Fbc-scroll-link/lists"}