# base-twitter-link

> Link to your Twitter

Latest version **1.0.1** (published 2015-06-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install base-twitter-link
pnpm add base-twitter-link
yarn add base-twitter-link
bun add base-twitter-link
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-06-26 |
| First published | 2015-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | twitter, link, base-element |

## Links

- npm: https://www.npmjs.com/package/base-twitter-link
- Repository: https://github.com/bendrucker/base-twitter-link
- Homepage: https://github.com/bendrucker/base-twitter-link#readme
- Issues: https://github.com/bendrucker/base-twitter-link/issues
- npm.io page: https://npm.io/package/base-twitter-link

## Dependencies (4)

- [xtend](https://npm.io/package/xtend.md) ~4.0.0
- [inherits](https://npm.io/package/inherits.md) ~2.0.1
- [object-omit](https://npm.io/package/object-omit.md) ~1.0.0
- [base-element](https://npm.io/package/base-element.md) ~3.0.1

## Recent versions

- 1.0.1 (latest) — 2015-06-26
- 1.0.0 — 2015-06-04

## README

# base-twitter-link [![Build Status](https://travis-ci.org/bendrucker/base-twitter-link.svg?branch=master)](https://travis-ci.org/bendrucker/base-twitter-link)

> A basic link to your Twitter built with [base-element](https://github.com/shama/base-element)


## Install

```
$ npm install --save base-twitter-link
```


## Usage

```js
var TwitterLink = require('base-twitter-link')
new TwitterLink().toString('bendrucker')
```

```html
<a href="https://twitter.com/bendrucker" rel="me" title="Follow me on Twitter @bendrucker">@bendrucker</a>
```

## API

#### `new TwitterLink([el])` -> `link`

##### el

Type: `HTMLElement`

The optional HTML element to append to.

#### `link.render(username)` -> `vdom`

##### username

*Required*  
Type: `string` / `object`

Your username. Optionally, pass an object with properties for the `<a>` element like `title` to override the defaults.

#### `link.toString(username)` -> `html`

Same signature as `link.render`, returning an html string instead of vdom. 

## License

MIT © [Ben Drucker](http://bendrucker.me)

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