# nw-nerdlayoutjs

> api wrapper for loading the nerdwallet header and footer into a js app

Latest version **0.1.0** (published 2015-06-09) · ISC license · 0 weekly downloads

## Install

```sh
npm install nw-nerdlayoutjs
pnpm add nw-nerdlayoutjs
yarn add nw-nerdlayoutjs
bun add nw-nerdlayoutjs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-06-09 |
| First published | 2015-05-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | August Flanagan |
| Maintainers | nerdwallet |

## Links

- npm: https://www.npmjs.com/package/nw-nerdlayoutjs
- npm.io page: https://npm.io/package/nw-nerdlayoutjs

## Dependencies (6)

- [nets](https://npm.io/package/nets.md) ^3.1.0
- [tape](https://npm.io/package/tape.md) ^4.0.0
- [standard](https://npm.io/package/standard.md) ^3.8.0
- [npm-run-all](https://npm.io/package/npm-run-all.md) ^1.2.4
- [event-stream](https://npm.io/package/event-stream.md) ^3.3.1
- [concat-stream](https://npm.io/package/concat-stream.md) ^1.4.8

## Recent versions

- 0.1.0 (latest) — 2015-06-09
- 0.0.2 — 2015-05-19
- 0.0.1 — 2015-05-04

## README

# nw-nerdlayoutjs

Client wrapper for calling out to the global-nav service.

## installation

```
npm i nw-nerdlayoutjs --save
```

## usage

```js
var nerdlayout = require('nw-nerdlayoutjs')

nl = nerdlayout({
  title : 'Test title',
  keywords: 'foo, bar, baz',
  description: 'a beautiful test',
  theme: 'health',
  forceDesktop: 'true',
  includePathsJS: ['../app-site/js/test.js'],
  includePathsCSS: ['../app-site/css/test.css'],
  ogTags: {
    title: 'TEST TITLE',
    image: 'http://assets.nerdwallet.com/img/nw-logos/NW_logo_200x200.png',
  },
  canonicalURL: 'http://www.nerdwallet.com',
  disclaimers: ['nonCommissionedContent']
})

nl.fetch(console.log)
```

## methods

### var nl = nerdlayout(options)

```js
var options = {
  title : 'Test title',  // page title
  keywords: 'foo, bar, baz', // keywords for meta keywords tag
  description: 'a beautiful test', // description for meta description tag
  theme: 'health', // used primarily by legacy NW php apps as a way to namespace asset paths
  forceDesktop: 'true', // sets viewport width to desktop size
  includePathsJS: ['../app-site/js/test.js'], // paths to additional js files that should be included on the page (these will be added to the page before the close of the body tag)
  includePathsCSS: ['../app-site/css/test.css'], // paths to additional js files that should be included
  ogTags: {
    title: 'TEST TITLE',
    image: 'http://assets.nerdwallet.com/img/nw-logos/NW_logo_200x200.png',
  }, // facebook og meta tags
  canonicalURL: 'http://www.nerdwallet.com', // href for canonical link tag
  disclaimers: ['nonCommissionedContent'] // list of disclaimer types to be added to the footer
}
```

### nl.fetch(callback)

Will make an http request to the global nav service that will include the config options specified by the caller.
`callback` will be invoked when the response is returned from the global nav service. It will be passed the following three params:

  - `error` - an exception object if an error occured (otherwise it will be null)
  - `top` - the html from the `DOCTYPE` declaration through the opening of the `#main` container
  - `bottom` - the html from the close of the `#main` container through the closing `html` tag

## middleware

Included is a function for creating connect middleware that will fetch global-nav
data for you adding it to `res.locals.nerdlayout` for easy access in your route
handlers.

This will fetch global-nav data w/ sane defaults.

```
var app = require('express')()
var middleware = require('nw-nerdlayoutjs/lib/middleware')

app.use(middleware())
app.get('/nerd', function (req, res) {
  res.send(
    res.locals.nerdlayout.top +
    'My content' +
    res.locals.nerdlayout.bottom
  )
})
```

You'll probably want to customize the configuration sent to global-nav such as
the page title and additional assets. You can pass in a callback hook and
return your own configuration which will be extended w/ the sane defaults.

```
var app = require('express')()
var middleware = require('nw-nerdlayoutjs/lib/middleware')

var custom = middleware(function (req, res, callback) {
  var config = {
    title: 'Nerdy Title'
  }

  callback(null, config)
})

app.use(custom)
app.get('/nerd', function (req, res) {
  res.send(
    res.locals.nerdlayout.top +
    'My content' +
    res.locals.nerdlayout.bottom
  )
})
```

---
_Source: https://npm.io/package/nw-nerdlayoutjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
