addressbar-ts

addressbar-ts

Makes the addressbar of the browser work just like a normal input

What is this thing?

How would you handle URLs if the addressbar was just an input? An input you could listen to changes, preventDefault() on and manually set the value without any sideeffect? What if you could think about changing the url as an event in your app, which you reacted to, instead of letting a route library swallow your view layer and mess around with it in a strongly opinionated way? What if you could have the freedom to make the URL mean whatever you wanted? Not just changes in what views to display?

The library just exposes the addressbar. It is a single entity in your app where you can:

// At http://www.example.com

addressbar.value // "http://www.example.com"

// Change addressbar value does NOT trigger route change
addressbar.value = 'http://wwww.example.com/test'

// You can force a replace of the url setting an object as value
addressbar.value = {
  value: 'http://www.example.com/test',
  replace: true
}

// You have access to location properties
addressbar.origin // "http://www.example.com"
addressbar.port // ""
addressbar.protocol // "http:"
addressbar.hostname // "www.example.com"
addressbar.pathname // "/"
addressbar.hash // ""

// Prevent route changes on hyperlinks
addressbar.addEventListener('change', function (event) {
  event.preventDefault()
  event.target.value // The value of the addressbar
})

This is low level code, so there is no routing logic here. Please check out url-mapper which can be used to create routing logic.

Under the hood

Addressbar listens to popstate events and handles hyperlinks.It basically has logic to simulate how an input works, also handling a few edge cases.

TypeScript

Addressbar is now written in TypeScript and you can import addressbar and the Addressbar class type with:

import addressbar from 'addressbar-ts'
import type { Addressbar } from 'addressbar-ts'

Tests

Addressbar is running with selenium-driver and vitest to test live in Chrome. Requires the Chrome or Chromium browser to be installed.

Run tests:

npm install
npm start   # Fires up the http-server
npm test    # Runs tests after running build