npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@profiscience/knockout-contrib-router-middleware-flash-message

v2.0.17

Published

[![Version][npm-version-shield]][npm] [![Dependency Status][david-dm-shield]][david-dm] [![Peer Dependency Status][david-dm-peer-shield]][david-dm-peer] [![Dev Dependency Status][david-dm-dev-shield]][david-dm-dev] [![Downloads][npm-stats-shield]][npm-sta

Downloads

69

Readme

router.middleware.flashMessage

Version Dependency Status Peer Dependency Status Dev Dependency Status Downloads

NOTE: This package is intended for consumption via the @profiscience/knockout-contrib metapackage

Display a flash message which will be removed after the next navigation.

Usage

Register the Middleware

import { flashMessageMiddleware } from '@profiscience/knockout-contrib'

Router.use(flashMessageMiddleware)

Displaying the Flash Message

Create a custom flash message component the exported flashMessage observable, or include the flash-message component (<contrib-flash-message></contrib-flash-message>).

Default Flash Message Component

See components.flash-message

Custom Flash Message Component

import * as ko from 'knockout'
import { Router, flashMessage } from '@profiscience/knockout-contrib'

/**
 * flashMessage is an observable contatining the value passed below
 *
 * The following is an example of how you could add custom properties for your flash message
 */

// If using TypeScript, define the interface for your flash message
declare module '@profiscience/knockout-contrib-router-middleware-flash-message' {
  // tslint:disable-next-line no-shadowed-variable
  interface IFlashMessage {
    text: string
    type?: string
  }
}

ko.components.register('flash-message', {
  viewModel: {
    instance: {
      text: ko.pureComputed(() => {
        const unwrappedFlashMessage = flashMessage()
        if (typeof unwrappedFlashMessage === 'string') {
          return unwrappedFlashMessage
        } else {
          return unwrappedFlashMessage.text
        }
      }),
      css: ko.pureComputed(() => {
        const unwrappedFlashMessage = flashMessage()
        if (typeof unwrappedFlashMessage.type !== 'undefined') {
          return unwrappedFlashMessage.type
        } else {
          return 'info'
        }
      }),
    },
  },
  template: `<div class="flash-message" data-bind="text: text, css: css"><div>`,
})

Setting a Flash Message

Set message by extending the context prior to navigating via Router.update, ctx.update, or ctx.redirect via the with option and the exported symbol.

import { Router } from '@profiscience/knockout-contrib-router'
import { FLASH_MESSAGE } from '@profiscience/knockout-contrib-router-middleware'

/**
 * The following are supported by the default flash message component.
 * As shown above, you can configure this however you'd like if you're
 * using a custom component
 */
Router.update('/', {
  with: {
    // set only the text and use default values for other options
    [FLASH_MESSAGE]: 'You are not logged in!'

    [FLASH_MESSAGE]: {
      text: 'Saved successfully!',  // flash message text
      type: 'success',              // bootstrap alert type, default: info
      dismiss: true,                // allow dismissing the flash message, default: false
      timeout: 5000                 // automatically dismiss the flash message after timeout in ms, default: false
    }
  }
})