From bea81e23c158a135b04ddacdaaa1cd4551ad1f63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carl=20T=C3=B6rnqvist?= Date: Thu, 12 Jul 2018 11:03:30 +0200 Subject: [PATCH] Default hash option to true --- README.md | 16 +++++++++------- index.js | 2 +- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 11cfd72a..3c49d36c 100644 --- a/README.md +++ b/README.md @@ -284,12 +284,12 @@ Querystrings (e.g. `?foo=bar`) are ignored when matching routes. An object containing the key-value mappings exists as `state.query`. ### Hash routing -By default hashes are not taken into account when routing. Using hashes to -delimit routes (e.g. `/foo#bar`) is supported if the `hash` options set to -`true`. Regardless, when a hash is found we also check if there's an -available anchor on the same page, and will scroll the screen to the position. -Using both hashes in URLs and anchor links on the page is generally not -recommended. +By default hashes are treated as part of the url when routing. Using hashes to +delimit routes (e.g. `/foo#bar`) can be disabled by setting the `hash` +[option](#app--chooopts) to `false`. Regardless, when a hash is found we also +check if there's an available anchor on the same page, and will scroll the +screen to the position. Using both hashes in URLs and anchor links on the page +is generally not recommended. ### Following links By default all clicks on `` tags are handled by the router through the @@ -534,7 +534,9 @@ Initialize a new `choo` instance. `opts` can also contain the following values: - __opts.cache:__ default: `undefined`. Override default class cache used by `state.cache`. Can be a a `number` (maximum number of instances in cache, default `100`) or an `object` with a [nanolru][nanolru]-compatible API. -- __opts.hash:__ default: `false`. Treat hashes in URLs as part of the pathname, transforming `/foo#bar` to `/foo/bar`. This is useful if the application is not mounted at the website root. +- __opts.hash:__ default: `true`. Treat hashes in URLs as part of the pathname, + transforming `/foo#bar` to `/foo/bar`. This is useful if the application is + not mounted at the website root. ### `app.use(callback(state, emitter, app))` Call a function and pass it a `state`, `emitter` and `app`. `emitter` is an instance diff --git a/index.js b/index.js index e6d79804..f21bd913 100644 --- a/index.js +++ b/index.js @@ -38,7 +38,7 @@ function Choo (opts) { // properties for internal use only this._historyEnabled = opts.history === undefined ? true : opts.history this._hrefEnabled = opts.href === undefined ? true : opts.href - this._hashEnabled = opts.hash === undefined ? false : opts.hash + this._hashEnabled = opts.hash === undefined ? true : opts.hash this._hasWindow = typeof window !== 'undefined' this._cache = opts.cache this._loaded = false