{"id":13516112,"url":"https://github.com/huacnlee/turbolinks-prefetch","last_synced_at":"2025-03-31T05:31:17.419Z","repository":{"id":40123852,"uuid":"299162428","full_name":"huacnlee/turbolinks-prefetch","owner":"huacnlee","description":"Turbolinks extends for prefetch links to speeds up your website.","archived":true,"fork":false,"pushed_at":"2021-08-14T03:29:33.000Z","size":53,"stargazers_count":71,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T20:46:53.560Z","etag":null,"topics":["npm","prefetch","turbolinks"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/huacnlee.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-28T02:13:33.000Z","updated_at":"2024-11-30T05:50:21.000Z","dependencies_parsed_at":"2022-06-26T14:22:46.205Z","dependency_job_id":null,"html_url":"https://github.com/huacnlee/turbolinks-prefetch","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fturbolinks-prefetch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fturbolinks-prefetch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fturbolinks-prefetch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fturbolinks-prefetch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/huacnlee","download_url":"https://codeload.github.com/huacnlee/turbolinks-prefetch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246423527,"owners_count":20774795,"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":["npm","prefetch","turbolinks"],"created_at":"2024-08-01T05:01:19.248Z","updated_at":"2025-03-31T05:31:16.945Z","avatar_url":"https://github.com/huacnlee.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Turbolinks Prefetch\n\n[![](https://img.shields.io/npm/v/turbolinks-prefetch.svg)](https://www.npmjs.com/package/turbolinks-prefetch)\n\n[Turbolinks](https://github.com/turbolinks/turbolinks) extend for prefetch links to speeds up your website.\n\n[中文介绍与说明](https://ruby-china.org/topics/40471)\n\n## WorkFlow\n\n```\nhover --\u003e [prefetch] --\u003cno cache\u003e--\u003e [XHR fetch] -\u003e [Turbolinks cache.put]\n              |\n          \u003cexist cache / in fetching\u003e\n              |\n            ignore\n\nclick --\u003ccheck cache\u003e-- exist --\u003e [isPrefetch] -\u003e [Turbolinks.visit advance] ---\u003e [render page]\n             |                         |                 |\n             |                         |                 --async-\u003e [fetch background] -\u003e [render if updated]\n             |                         |\n             |                       \u003cYes\u003e\n             |                         |--- [Turbolinks.visit restore] --\u003e render -\u003e nothing\n          No cahce\n             |\n             ---\u003e [Turbolinks.visit]\n```\n\n## Installation\n\n```bash\n$ yarn add turbolinks-prefetch\n```\n\n## Usage\n\n```js\nimport Turbolinks from \"turbolinks\";\nwindow.Turbolinks = Turbolinks;\n\nimport TurbolinksPrefetch from \"turbolinks-prefetch\";\nTurbolinksPrefetch.start();\n```\n\nPrefetch request will send `Purpose: prefetch` header, so you may need this to ignore some thing.\n\nFor example views count increment:\n\n```rb\nclass TopicsController \u003c ApplicationController\n  def show\n    if request.headers[\"Purpose\"] != \"prefetch\"\n      # Ignore hit counter for prefetch request\n      @topic.increment_hit\n    end\n  end\nend\n```\n\n### Disable prefetch\n\nBy default, TurbolinksPrefetch will enable prefetch for all links.\n\nExcept:\n\n- Links not have same host (Origin);\n- Open in new window links `target=\"_blank\"`;\n- The links has `data-remote` attribute;\n- The links has `data-method` attribute;\n- The links has `data-prefetch=\"false\"` attribute;\n\nIf you wants disable prefetch, you can do like this:\n\n```html\n\u003ca href=\"https://google.com\"\u003eGoogle\u003c/a\u003e\n\u003ca href=\"/topics/123\" target=\"_blank\"\u003eOpen in new window\u003c/a\u003e\n\u003ca href=\"/topics/123\" data-method=\"PUT\" data-remote\u003ePut\u003c/a\u003e\n\u003ca href=\"/topics/123\" data-method=\"DELETE\"\u003eDelete\u003c/a\u003e\n\u003ca href=\"/topics/123\" data-prefetch=\"false\"\u003eDisable by directly\u003c/a\u003e\n```\n\n## Demo\n\n\u003cimg width=\"715\" alt=\"截屏2020-09-28 17 17 44\" src=\"https://user-images.githubusercontent.com/5518/94414149-92935b00-01ae-11eb-9916-778d7740db98.png\"\u003e\n\nhttps://github.com/ruby-china/homeland/commit/e1378468703b8c3cfd7e33a17dc703ff8294a3e9\n\n## Demo site\n\n- [Ruby China](https://ruby-china.org)\n- [HackerShare](https://hackershare.dev)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuacnlee%2Fturbolinks-prefetch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhuacnlee%2Fturbolinks-prefetch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuacnlee%2Fturbolinks-prefetch/lists"}