Pub Build Status codecov

History

history lets you manage session history in any environment. It uses a subset of the HTML5 session history API and brings it to the VM and Browsers that don't support session History manipulation. history abstracts away the differences in environments using a minimal API. This lets you easily change the history stack, navigate to different locations in your app, confirm navigation changes using custom prompts, and persist any custom state you want between sessions.

Usage

history provides 3 variants to use based on your environment:

  • MemoryHistory - For use in non-DOM environments such as the dart vm. All session information is stored in memory. This variant can be used in the browser if needed.
  • BrowserHistory - For use in modern browsers that support the HTML5 session history API. session information is stored using the browser's history API, allowing history manipulation from other sources to be synced with this history.
  • HashHistory - For use in legacy browsers. Relies on the hash-based paths and syncs with the browsers hashchange events. Custom states are not supported.

To use history, simply import and go!

// For use in Browser
import 'package:history/history.dart';
// For use in VM
// import 'package:history/vm.dart'; 

Confirmation confirmation = (_) => new Future.value(true);
MemoryHistory history = new MemoryHistory(getConfirmation: confirmation);

// Listen for changes
var sub = history.onChange.listen((updatedHistory) {
  var location = updatedHistory.location;
  print('Transitioned to ${location.path} with action ${updatedHistory.action}!');
  print('State associated with this location: ${location.state}');
});

// Manipulate the history
await history.push('/first');
await history.push('/second', 'with a state');
await history.replace('/third', {'with': 'a', 'state': 'object'});
await history.goBack();
await history.goForward();
await history.go(-1);

// Block transitions until they are confirmed by the user
history.block('Are you sure you want to navigate?');

// This call waits for a user confirmation before continuing
history.push('/confirmed');

// Use a more complex Prompt for more flexibilty
history.block((Location l, Action a) {
  if (l.path == '/logout') {
    return 'Logging out will cause you to lose all unsaved data!';
  } else if (a == Action.pop) {
    return 'Are you sure you want to go back?';
  }
  return 'Are you sure you want to navigate?';
});

// Prints different prompts based on the transition
await history.goBack();
await history.push('/logout');

// Return to non-blocking mode
history.unblock();

// Stop listening
sub.cancel();

Examples

Examples are available in the examples/ folder -- one for each type of history variant.

  • For Browser Examples, run pub get and pub serve example. Then navigate to localhost:8080
  • For a VM Example, run pub get then run dart example/example_vm.dart

Inspiration

This project is largely based on history, an npm package provided by React Training

Libraries

history
history.vm