Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/miyaoka/nuxt-twitter-widgets-module

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/miyaoka/nuxt-twitter-widgets-module
Owner: miyaoka
License: mit
Created: 2018-04-03T09:02:38.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-12-15T05:39:51.000Z (11 months ago)
Last Synced: 2024-03-15T09:22:24.851Z (8 months ago)
Language: JavaScript
Size: 78.1 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # @miyaoka/nuxt-twitter-widgets-module

[![npm (scoped with tag)](https://img.shields.io/npm/v/@miyaoka/nuxt-twitter-widgets-module/latest.svg?style=flat-square)](https://npmjs.com/package/@miyaoka/nuxt-twitter-widgets-module)

[![npm](https://img.shields.io/npm/dt/@miyaoka/nuxt-twitter-widgets-module.svg?style=flat-square)](https://npmjs.com/package/@miyaoka/nuxt-twitter-widgets-module)

[![CircleCI](https://img.shields.io/circleci/project/github/https://github.com/miyaoka@miyaoka//nuxt-twitter-widgets-module.svg?style=flat-square)](https://circleci.com/gh/https://github.com/miyaoka/@miyaoka/nuxt-twitter-widgets-module)

[![Codecov](https://img.shields.io/codecov/c/github/https://github.com/miyaoka/@miyaoka/nuxt-twitter-widgets-module.svg?style=flat-square)](https://codecov.io/gh/https://github.com/miyaoka/@miyaoka/nuxt-twitter-widgets-module)

[![Dependencies](https://david-dm.org/https://github.com/miyaoka/@miyaoka/nuxt-twitter-widgets-module/status.svg?style=flat-square)](https://david-dm.org/https://github.com/miyaoka/@miyaoka/nuxt-twitter-widgets-module)

[![js-standard-style](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com)

> Twitter widgets loader for Nuxt

[📖 **Release Notes**](./CHANGELOG.md)

## Features

* Add twitter widgets script to header

* [Initialize embedded tweet content](https://dev.twitter.com/web/javascript/initialization) on component mounted or updated by custom directive.

## Setup

* Add `@miyaoka/nuxt-twitter-widgets-module` dependency using yarn or npm to your project

* Add `@miyaoka/nuxt-twitter-widgets-module` to `modules` section of `nuxt.config.js`

```js

{

  modules: [

    // Simple usage

    '@miyaoka/nuxt-twitter-widgets-module',

    // With options

    [

      '@miyaoka/nuxt-twitter-widgets-module',

      {

        directiveName: 'twitter-widgets',

        scriptUrl: '//platform.twitter.com/widgets.js'

      }

    ]

  ]

}

```

## Usage

Add directive (default: v-twitter-widgets) to component that has tweet.

```

```

## Development

* Clone this repository

* Install dependnecies using `yarn install` or `npm install`

* Start development server using `npm run dev`

## License

[MIT License](./LICENSE)

Copyright (c) Masaya Kazama