0.1.61 • Published 5 years ago
sharetext-embedded v0.1.61
Share Text Embedded
Twiitter facebook LINEのシェアURLを自動で埋め込みます。
エンコード処理の削減で、
視認性・メンテナンス性を向上させます。
※update※
LINEのシェアURL変更に合わせ
facebookとLINEからtextを削除いたしました。
文言はog:descriptionから自動取得されます。
Get Start
download link => https://github.com/W-Kentaro/ShareTextEmbedded/archive/master.zip
npm
npm page => https://www.npmjs.com/package/sharetext-embedded
//npm install
npm i sharetext-embedded
// import
import {ShareTextEmbedded} from 'sharetext-embedded';
Script Tags
<script src="../dist/sharetext-embedded.min.js"></script>
DEMOS
sample page => https://w-kentaro.github.io/ShareTextEmbedded/sample/
Overview
SNSシェア文を自動エンコードして挿入します
<a href="" target="_blank" data-share="twitter">Twitterシェアテキスト</a>
<a href="" target="_blank" data-share="facebook">facebookシェアテキスト</a>
<a href="" target="_blank" data-share="line">LINEシェアテキスト</a>
Template
基本テンプレート
var ShareText = new ShareTextEmbedded({
url: 'URLを入れてください。',
text: 'シェア文を入れてください。',
hash: 'ハッシュタグ',
});
HTMLとJSに分けて管理
// HTMLに記述
<script>
var share ={
url: 'URL',
text: 'シェア文を入れてください。',
hash: 'ハッシュタグ',
}
</script>
var ShareText = new ShareTextEmbedded(share);
最小テンプレート
var ShareText = new ShareTextEmbedded();
data-shareに入れたSNSに対応するhrefを吐き出します
Properties
var share = {
init: true,
url: 'URL',
text:'share text',
hash: 'hash', // 複数の場合はカンマで区切る
twitter: {
elem: 'element',
url : 'URL',
text: 'share text',
hash: 'hash', // 複数の場合はカンマで区切る
via: 'sample',
related: 'sample'
},
facebook: {
elem: 'element',
url : 'URL',
},
line: {
elem: 'element',
url : 'URL',
}
};
COMMON
プロパティ | デフォルト | 説明 |
---|---|---|
init | true | trueで自動的に挿入 falseの場合init()時に挿入 |
url | og:url | シェアに埋め込まれるURL 指定がない場合はog:urlを使用 |
text | og:description | シェア文言、指定がない場合og:descriptionを使用 |
hash | false | ハッシュタグ 現在はTwitterのみ使用 twitter.hashに上書きされる |
プロパティ | デフォルト | 説明 |
---|---|---|
'disable'でtwitterシェア文は生成されない | ||
elem | data-share="twitter" | 挿入箇所 class/id/data属性で指定 |
url | common url | シェアに埋め込まれるURL 指定がない場合はcommon urlを使用 nullでURL空に(TEXTが空の場合はエラー) |
text | common text | シェア文言、指定がない場合common textを使用 nullでテキストを空に(URLが空の場合はエラー) |
hash | false | ハッシュタグ 指定がない場合は表示しない カンマで複数 |
via | false | アカウント指定 指定がない場合は表示しない |
related | false | おすすめユーザー表示 指定がない場合は表示しない |
プロパティ | デフォルト | 説明 |
---|---|---|
'disable'でfacebookシェア文は生成されない | ||
elem | data-share="facebook" | 挿入箇所 class/id/data属性で指定 |
url | common url | シェアに埋め込まれるURL 指定がない場合はcommon urlを使用 |
LINE
プロパティ | デフォルト | 説明 |
---|---|---|
line | 'disable'でLINEシェア文は生成されない | |
elem | data-share="line" | 挿入箇所 class/id/data属性で指定 |
url | common url | シェアに埋め込まれるURL 指定がない場合はcommon urlを使用 |
Parameters
パラメータ | 説明 |
---|---|
ShareText.URL.twitter | TwitterのシェアURL |
ShareText.URL.facebook | facebookのシェアURL |
ShareText.URL.line | LINEのシェアURL |
Methods
- init()
ShareText.init();
宣言時にhrefに書き込み
- update()
Sharetext.update({data});
シェアの内容をdataの中身で上書き、
init()しないとurlの変更はされません。