Giter Club home page Giter Club logo

bs-universal-router's Introduction

bs-universal-router

Bucklescript bindings for Universal Router

Use

bs-universal-router can be used with modern state management solutions like Meiosis to great effect. No need for Virtual DOMs or other "complex machinery" at this point in time ;)

See this video example

Writing bindings

To help write bucklescript bindings for this lib (and hence make it usable from ReasonML) see the FFI cheatsheet and go for it!

Install

npm i bs-universal-router

Add bs-universal-router to dependencies in bsconfig.json

Api

See Universal router API

Api changes

TODO

Usage

open UniversalRouter;

let routes = {
  path: "/page", /* string or regexp or array of them, optional */
  name: "page",  /* unique string, optional */
  parent: None,  /* Some(route) object or None */
  children: Some([]), /* Some list of child route objects or None */
  /* what to do when route activated */
  action: (context, params) => {
    /* some action */
  }
};

let options = {
  context: { },
  baseUrl: "/base",
  resolveRoute: (context, params) => {
    if (typeof context.route.action === "function") {
      context.route.action(context, params);
    } else {
      unit
    };
  },
  errorHandler: (error, context) => {
    Js.log(error);
    Js.log(context);
    if error.status === 404 {
      "<h1>Page Not Found</h1>";
    } else {
      "<h1>Oops! Something went wrong</h1>";
    };
  }
};

let router = UniversalRouter.make(routes, ~options=options);

Build

npm run build

Watch

npm run watch

Editor

If you use vscode, Press Windows + Shift + B it will build automatically

bs-universal-router's People

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

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.