https://github.com/bunesk/vue-twitter-timeline

Vue3 component for embed twitter timeline
https://github.com/bunesk/vue-twitter-timeline

twitter twitter-embed twitter-timeline vue vue3-component vuejs

Last synced: 6 days ago
JSON representation

Vue3 component for embed twitter timeline

• Host: GitHub
• URL: https://github.com/bunesk/vue-twitter-timeline
• Owner: bunesk
• License: mit
• Created: 2022-01-07T12:45:59.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-12T13:53:46.000Z (about 2 years ago)
• Last Synced: 2024-11-12T00:04:55.227Z (2 months ago)
• Topics: twitter, twitter-embed, twitter-timeline, vue, vue3-component, vuejs
• Language: Vue
• Homepage: https://bunesk.net/vue-twitter-timeline/
• Size: 582 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vue Twitter Timeline

A Vue3 component which allows you to easily embed twitter timelines.

If you are looking for a Vue3 component to embed tweets check out [this](https://github.com/DannyFeliz/vue-tweet).

## Installation

```

npm install vue-twitter-timeline

```

## Usage

```javascript

import TwitterTimeline from 'vue-twitter-timeline';

```

```vue

```

### Props

| Property      | Description                                        | Type             | Default                  |

| ------------- | -------------------------------------------------- | ---------------- | ------------------------ |

| `url`         | The timeline url part after `https://twitter.com/` | `string`         | -                        |

| `description` | Text to show while loading or if it can't load     | `string`         | `''`                     |

| `height`      | Height in pixels                                   | `string`         | `''`                     |

| `width`       | Width in pixels                                    | `string`         | `''`                     |

| `lang`        | Language key to use                                | `string`         | browser setting / `en`   |

| `theme`       | Theme to use                                       | `light` / `dark` | system setting / `light` |

| `doNotTrack`  | If tracking should be prevented                    | `boolean`        | `false`                  |

## Project setup

```

npm install

```

### Compiles and hot-reloads for development

```

npm start

```

### Release and publish new version

```

npm run release

```

### Build for demo site

```

npm run build-site

```

### Update dependencies

```

npm run update

```

## License

MIT