Giter VIP home page Giter VIP logo

kief's Introduction

Kief

Simple framework agnostic hash router inspired by redux.

Usage

import createRouter from 'kief'

// Define the routes
const router = createRouter([
  '/about',
  '/users',
  '/users/:id', // use colon to define parameters
])

// Listen to hash changes
router.subscribe(routeInfo => {
  // Do whatever
})

The callback inside .subscribe takes a RouteInfo argument:

export interface RouteInfo {
  matchesRoute: boolean // Does the current hash match a defined route
  params: { [key: string]: string } // Parameters defined with colon
  query: { [key: string]: string } // Query parameters
  route?: string // The matched route if applicable
}

Examples

with lit-html

// The router
const router = createRouter([
  '/query',
  '/users/:id',
])

// The components
const Header = () =>
  html`
    <header>
      <a href="#/">Home</a>
      <a href="#/user/1">User One</a>
      <a href="#/query?foo=bar&hello=world">Some page with query parameters</a>
    </header>
  `
const Home = () => html`<h1>Home</h1>`
const User = (id: string) => html`<h1>User ${id}`
const Query = (query: { [key: string]: string }) =>
  html`
    <h1>Some page with query parameters</h1>
    <table>
      <tr><th>KEY</th><th>VALUE</th></tr>
      ${
        Object.keys(query).map(key => html`<tr><td>${key}</td><td>${object[key]}</td></tr>`)
      }
    </table>
  `
const Page = ({ params, query, route }: RouteInfo) => {
  switch(route) {
    case '/query': return Query(query)
    case '/users/:id': return User(params.id)
    default: return Home()
  }
}
const App = (routeInfo: RouteInfo) =>
  html`
    ${Header()}
    ${Page(routeInfo)}
  `

// Re-render app on route changes
router.subscribe(routeInfo => {
  render(App(routeInfo), document.body)
})

With redux

// Pass route changes to the store
router.subscribe(routeInfo => store.dispatch({ type: ROUTE_CHANGE, payload: routeInfo }))

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.