# gc-hero-widgets

> Hero widget for Apostrophe CMS

Latest version **0.0.6** (published 2018-05-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install gc-hero-widgets
pnpm add gc-hero-widgets
yarn add gc-hero-widgets
bun add gc-hero-widgets
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2018-05-19 |
| First published | 2018-04-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gareth Cooper |
| Maintainers | gaco79 |
| Keywords | apostrophe, cms, website, hero, widget |

## Links

- npm: https://www.npmjs.com/package/gc-hero-widgets
- Repository: https://github.com/gaco79/gc-hero-widgets
- Homepage: https://github.com/gaco79/gc-hero-widgets#readme
- Issues: https://github.com/gaco79/gc-hero-widgets/issues
- npm.io page: https://npm.io/package/gc-hero-widgets

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2018-05-19
- 0.0.5 — 2018-05-16
- 0.0.4 — 2018-05-09
- 0.0.3 — 2018-05-01
- 0.0.2 — 2018-04-29
- 0.0.1 — 2018-04-29

## README

# HERO WIDGET

An [Apostrophe CMS](http://apostrophecms.org/) module to display a "hero". A hero is a full width banner possibly containing a headline or brief strapline. Usually it is displayed as the first item on a web page.

## Install

From within your apostrophe project

 `npm install --save gc-hero-widgets`

## Configuration

In app.js
```javascript
modules: {
  'gc-hero-widgets': {},
  // ... other modules
}
```

In your template
```nunjucks
{{ apos.area(data.page, 'body', {
    widgets: {
      'gc-hero': {}
  }
}) }}
```
Remember to replace `data.page` with the appropriate context,
and `body` with the correct area name for your site.

By default, the hero allows you to choose  `apostrophe-rich-text`, `apostrophe-images`, and `apostrophe-video` widgets. You can override the available options by creating the file `lib/modules/gc-hero-widgets/views/widget.html` and using something like the following:

```nunjucks
{% extends 'widgetBase.html' %}

{% block heroContent %}
  {{ apos.area(data.widget, 'content', {
    widgets: {
      'your-own': {},
      'choice-of-widgets': {},
      'go-here': {}
    }
  }) }}
{% endblock %}
```

## Contributing

Please contribute ideas, issues and improvements at the GitHub repository.

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