一篇文章Stimulus:連接HTML和JavaScript的橋梁,實(shí)現(xiàn)簡(jiǎn)單的controller,并學(xué)習(xí)了Stimulus是如何連接HTML與JavaScript的。現(xiàn)在我們使用Stimulus來實(shí)現(xiàn)復(fù)制文本到粘貼板的按鈕。
比如說,我們現(xiàn)在有一個(gè)需求,就是幫助用戶生成密碼,在密碼旁邊放置一個(gè)按鈕,點(diǎn)擊按鈕后密碼就被拷貝到粘貼板上了,這樣就方便用戶使用這個(gè)密碼了。
打開public/index.html,修改body內(nèi)容,填充一個(gè)簡(jiǎn)單的按鈕,如下:
<div>
PIN: <input type="text" value="1234" readonly>
<button>Copy to Clipboard</button>
</div>
下一步,創(chuàng)建src/controllers/clipboard_controller.js,然后添加一個(gè)copy()方法:
import { Controller } from "@hotwired/stimulus"
export default class extends Controller {
copy() {
}
}
然后,給div添加data-controller=“clipboard”。只要是給元素添加了data-controller屬性,Stimulus就會(huì)連接一個(gè)controller實(shí)例。
<div data-controller="clipboard">
我們還需要一個(gè)對(duì)輸入框的引用,這樣我們就可以在調(diào)用粘貼板API之前獲取輸入框的內(nèi)容。給文本框添加data-clipboard-target=“source“:
PIN: <input data-clipboard-target="source" type="text" value="1234" readonly>
在controller中定義一個(gè)target,然后就可以通過this.sourceTarget訪問文本框了。
import { Controller } from "@hotwired/stimulus"
export default class extends Controller {
static targets = [ "source" ]
copy() {
}
}
解釋一下這個(gè)targets:
當(dāng)Stimulus加載你的controller類時(shí),它會(huì)查看靜態(tài)數(shù)組targets的字符串元素,對(duì)于每一個(gè)字符串,Stimulus會(huì)在controller中添加3個(gè)屬性。在這里,對(duì)于“source”,會(huì)添加如下屬性:
this.sourceTarget 在controller的域內(nèi)的第一個(gè)source
this.sourceTargets 在controller的域內(nèi)所有的source組成的一個(gè)數(shù)組
this.hasSourceTarget 在controller的域內(nèi)是否有source
我們希望點(diǎn)擊按鈕時(shí)調(diào)用controller中的copy()方法,所以我們需要添加data-action=“clipboard#copy“
<button data-action="clipboard#copy">Copy to Clipboard</button>
你可以已經(jīng)注意到在上面的動(dòng)作描述符中省略了click->。那是因?yàn)镾timulus給button設(shè)置了click作為它默認(rèn)的事件。
某些其他元素也有默認(rèn)事件。下面是個(gè)全部列表:
元素 | 默認(rèn)事件 |
a | click |
button | click |
details | toggle |
form | submit |
input | input |
input type=“submit” | click |
select | change |
textarea | input |
最終,在copy()方法中,我們獲取輸入框的內(nèi)容,調(diào)用粘貼板API
copy() {
navigator.clipboard.writeText(this.sourceTarget.value)
}
刷新頁(yè)面,點(diǎn)擊按鈕,然后快捷鍵粘貼到Greet按鈕前到輸入框,可以看到1234。
到目前為止,在頁(yè)面上同一時(shí)間只有一個(gè)controller實(shí)例。在頁(yè)面上同時(shí)有一個(gè)controller的多個(gè)實(shí)例也是很正常的。
我們的controller是可以復(fù)用的,只要你需要在頁(yè)面上添加復(fù)制內(nèi)容的按鈕,無論是哪個(gè)頁(yè)面,只要把對(duì)應(yīng)的屬性值寫好,我們的controller都是生效的。
還是上面的例子,再添加另外一個(gè)復(fù)制按鈕:
<div data-controller="clipboard">
PIN: <input data-clipboard-target="source" type="text" value="3737" readonly>
<button data-action="clipboard#copy" class="clipboard-button">Copy to Clipboard</button>
</div>
刷新頁(yè)面,驗(yàn)證一下兩個(gè)復(fù)制按鈕是否都生效。
我們?cè)偬砑右粋€(gè)可以復(fù)制的元素,不用button,我們用a標(biāo)簽,
<div data-controller="clipboard">
PIN: <input data-clipboard-target="source" type="text" value="6666" readonly>
<a href="#" data-action="clipboard#copy" class="clipboard-button">Copy to Clipboard</a>
</div>
Stimulus允許我們使用任何元素,只要它設(shè)置了合適的data-action屬性,就可以觸發(fā)復(fù)制。
這個(gè)例子里,要注意一點(diǎn),點(diǎn)擊鏈接會(huì)使瀏覽器追蹤a標(biāo)簽內(nèi)的href屬性跳轉(zhuǎn),可以取消這種默認(rèn)行為,只需要在action中調(diào)用 event.preventDefault()就可以了。
copy(event) {
event.preventDefault()
navigator.clipboard.writeText(this.sourceTarget.value)
}
還有另外一個(gè)方法,拷貝粘貼板上
copy(event) {
event.preventDefault()
this.sourceTarget.select()
document.execCommand("copy")
}
在本文中,我們看了一個(gè)在現(xiàn)實(shí)中把瀏覽器API包裝在Stimulus的controller中的例子。還有一個(gè)controller的多個(gè)實(shí)例如何同時(shí)出現(xiàn)在頁(yè)面上,我們還探索了actions和targets如何保持HTML和JavaScript的松散耦合。
下一篇文章,我們將優(yōu)化一下這個(gè)復(fù)制粘貼板的功能,讓它運(yùn)行起來更加健壯。
Stimulus:瀏覽器不支持復(fù)制或者弱網(wǎng)條件下,怎么辦?
鈕(button)可能是網(wǎng)頁(yè)中最常見的組件之一了,大部分都平淡無奇,如果你碰到的是一個(gè)這樣的按鈕,會(huì)不會(huì)忍不住多點(diǎn)幾次呢?
轉(zhuǎn)載鏈接: https://github.com/XboxYan/notes/issues/16
通常這類效果第一反應(yīng)可能就是借助canvas了,比如下面這個(gè)案例點(diǎn)擊預(yù)覽(建議去codepen原鏈接點(diǎn)擊預(yù)覽訪問,segmentfault內(nèi)置的預(yù)覽js會(huì)加載失敗)
效果就更加震撼了,當(dāng)然canvas實(shí)現(xiàn)也有一定的門檻,而且實(shí)際使用起來也略微麻煩(所有js實(shí)現(xiàn)的通病),這里嘗試一下CSS的實(shí)現(xiàn)方式。
拋開js方案,還有HTML和CSS實(shí)現(xiàn)方式。HTML就不用說了,直接寫上大量的標(biāo)簽
<button>
button
<i></i>
<i></i>
<i></i>
<i></i>
<i></i>
...
</button>
一般情況下我不是很喜歡這種方式,標(biāo)簽太多,結(jié)構(gòu)不美觀,而且有可能對(duì)現(xiàn)有的頁(yè)面造成其他影響(很多情況下并不方便修改原始HTML結(jié)構(gòu))
那么來看看CSS實(shí)現(xiàn)方式,主要也是兩種方式,其實(shí)就是想一下有哪些屬性可以無限疊加,一個(gè)是box-shadow,還有一個(gè)是background-image(CSS3支持無限疊加)。
我們先看看box-shadow方式,為了避免使用額外標(biāo)簽,這里采用偽元素生成。
.button::before{
position: absolute;
content: '';
width: 5px;
height: 5px;
border-radius: 50%;
background-color: #ff0081;
box-shadow: 10px 10px #ff0081,15px 0px 0 2px #ff0081,20px 15px 0 3px #ff0081,...;/*無限疊加*/
}
效果還是有的,主要就是多花點(diǎn)時(shí)間來調(diào)試,這里主要根據(jù)偏移量和擴(kuò)展來決定粒子的位置和大小。
不過這里的偏移量只能是px單位,無法很好的自適應(yīng)按鈕的大小,所以這里采用第二種方式來實(shí)現(xiàn)
CSS3中background-image是可以無限疊加的,類似于
.myclass {
background: background1, background2, /*...*/ backgroundN;
}
這里我們可以采用徑向漸變r(jià)adial-gradient來實(shí)現(xiàn)多個(gè)小圓點(diǎn)。
.button::before{
position: absolute;
content: '';
left: -2em;
right: -2em;
top: -2em;
bottom: -2em;
pointer-events: none;
background-repeat: no-repeat;
background-image: radial-gradient(circle, #ff0081 20%, transparent 0),
radial-gradient(circle, #ff0081 20%, transparent 0),
radial-gradient(circle, #ff0081 20%, transparent 0),
radial-gradient(circle, #ff0081 20%, transparent 0),
...;
background-size: 10% 10%, 20% 20%, 15% 15%,...;
background-position: 18% 40%, 20% 31%, 30% 30%,...;
}
這里主要通過background-size和background-position來控制原點(diǎn)的尺寸與位置,看著好像挺復(fù)雜,其實(shí)只要background-size和background-position與background-image位置一一對(duì)應(yīng)就行了。實(shí)際開發(fā)中可能有點(diǎn)難調(diào)試,可以直接在控制臺(tái)中通過鍵盤上下左右鍵微調(diào)實(shí)時(shí)預(yù)覽效果(可以考慮做一個(gè)可視化工具)。
這樣就做出了一個(gè)簡(jiǎn)單的粒子效果。
雖然background-image不支持CSS動(dòng)畫,但是另外兩個(gè)background-size和background-position支持呀,所以,CSS transition和CSS animation都可以用起來。
動(dòng)畫效果很簡(jiǎn)單,就是粒子從中心往外擴(kuò)散,并且逐漸消失的過程。
我們先看看:hover交互
.button::before{
transition:.75s background-position ease-in-out,75s background-size ease-in-out;
}
.button:hover::before{
background-position: 5% 44%, -5% 20%, 7% 5%...;
background-size: 0% 0%;
}
當(dāng)然直接這樣設(shè)置肯定是不理想,鼠標(biāo)離開時(shí)會(huì)收縮回去,效果如下
我們需要是鼠標(biāo)離開時(shí)不收縮回去,如何實(shí)現(xiàn)呢?
很簡(jiǎn)單,把transition設(shè)置在:hover下就可以了,表示只有當(dāng)鼠標(biāo)經(jīng)過時(shí)才有過渡,離開時(shí)沒有
.button:hover::before{
background-position: 5% 44%, -5% 20%, 7% 5%...;
background-size: 0% 0%;
transition:.75s background-position ease-in-out,75s background-size ease-in-out;
}
這樣是不是感覺稍微好些了呢?點(diǎn)擊這里點(diǎn)擊預(yù)覽查看。
如果我們想做成點(diǎn)擊的時(shí)候出現(xiàn)粒子動(dòng)畫該怎么做呢?這里就需要借助:active偽類了。
如果我們按照:hover邏輯,那么
.button:active::before{
background-position: 5% 44%, -5% 20%, 7% 5%...;
background-size: 0% 0%;
transition:.75s background-position ease-in-out,75s background-size ease-in-out;
}
很遺憾,只有當(dāng)只有按住不動(dòng)的時(shí)候才能觸發(fā),一旦鼠標(biāo)抬起就沒有了,這個(gè)時(shí)候我們就需要換個(gè)角度了。可以這么想象一下,默認(rèn)就是發(fā)散的,然后點(diǎn)擊的時(shí)候聚攏,抬起的時(shí)候就會(huì)有還原成之前的發(fā)散狀態(tài),同時(shí),在點(diǎn)擊的時(shí)候需要取消掉過渡效果,如下
.button::before {
/*...*/
background-position: 5% 44%...;/*擴(kuò)散的狀態(tài)*/
background-size: 0% 0%;
transition: background-position .5s ease-in-out, background-size .75s ease-in-out;
}
.button:active::before {
transition:0s;/**注意取消掉過渡**/
background-size: 10% 10%, 20% 20%...;
background-position: 18% 40%, 20% 31%,...;
}
你可以查看這個(gè)demo點(diǎn)擊預(yù)覽
為什么在:active需要transition:0s呢,你可以試下不添加的效果就明白了,如下
animation和transition實(shí)現(xiàn)原理比較類似,優(yōu)點(diǎn)是可以做出更加精細(xì)的動(dòng)畫,這里就拿:active方式來說吧。
.button::before{
/*...*/
animation: bubbles ease-in-out .75s forwards;
}
.button:active::before {
animation: none; /*這里注意取消動(dòng)畫*/
background-size: 0;
}
@keyframes bubbles {
0% {
background-position: 18% 40%, ...;
}
50% {
background-position: 10% 44%, ...;
}
100% {
background-position: 5% 44%, ...;
background-size: 0% 0%;
}
}
可以在這里點(diǎn)擊預(yù)覽查看源碼。
唯一的不足可能是初始化動(dòng)畫會(huì)自執(zhí)行一次。
上面介紹了純CSS實(shí)現(xiàn)一個(gè)粒子動(dòng)效的按鈕,優(yōu)點(diǎn)很明顯,復(fù)制一下CSS直接扔到項(xiàng)目里就能用,管他什么原生項(xiàng)目還是react項(xiàng)目,也無需綁定什么事件,也無需額外的邏輯處理,增強(qiáng)現(xiàn)有體驗(yàn)。試想一下,如果這是一個(gè)‘購(gòu)買’按鈕,會(huì)不會(huì)觸發(fā)你多購(gòu)買幾次呢,反正我肯定是會(huì)被吸引住了,哈~缺點(diǎn)也還是有的,比如上面的定位,密密麻麻都是工作量啊,建議這些功能在項(xiàng)目整體完成之后再細(xì)細(xì)打磨,也可以試著做一些可視化工具來減輕工作量,完。
clipboard.js是一款不依賴flash或任何重量級(jí)框架的粘貼復(fù)制插件,并且它沒有任何非常復(fù)雜的配置,這也是它存在的原因。
npm install clipboard --save
2.引入js
<script src="dist/clipboard.min.js"></script>
//官網(wǎng)提供了下載地址,也可以使用免費(fèi)的cdn
示例
<!DOCTYPE html> <html class="no-js"> <head> <meta charset="utf-8" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <title></title> <meta name="description" content="" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" /> </head> <body> <div class="input-group" style="width: 600px;margin:200px"> <input type="text" class="form-control" id="foo" value="https://github.com/zenorocha/clipboard.js.git" placeholder="Amount" /> <div class="btn input-group-addon" data-clipboard-target="#foo">復(fù)制</div> </div> <script src="https://cdn.jsdelivr.net/npm/clipboard@2/dist/clipboard.min.js"></script> <script> new ClipboardJS(".btn"); </script> </body> </html>
如圖書最簡(jiǎn)單的例子,單機(jī)復(fù)制按鈕即可自動(dòng)復(fù)制文本框的內(nèi)容
換成下面就會(huì)變成剪切,主要是以下屬性
data-clipboard-action="cut"
<div class="input-group" style="width: 600px;margin:200px"> <input type="text" class="form-control" id="foo" value="https://github.com/zenorocha/clipboard.js.git" placeholder="Amount" /> <div class="btn input-group-addon" data-clipboard-target="#foo" data-clipboard-action="cut">剪切</div> </div> <script src="https://cdn.jsdelivr.net/npm/clipboard@2/dist/clipboard.min.js"></script> <script> new ClipboardJS(".btn"); </script>
剪切操作僅適用于<input>或<textarea>元素
或者這樣,直接復(fù)制 data-clipboard-text屬性的內(nèi)容
<button class="btn" data-clipboard-text="要復(fù)制的內(nèi)容"> 復(fù)制 </button>
var clipboard = new ClipboardJS('.btn'); clipboard.on('success', function(e) { console.info('Action:', e.action); console.info('Text:', e.text); console.info('Trigger:', e.trigger); e.clearSelection(); }); clipboard.on('error', function(e) { console.error('Action:', e.action); console.error('Trigger:', e.trigger); });
new ClipboardJS('.btn', { target: function(trigger) { return trigger.nextElementSibling; } });
new ClipboardJS('.btn', { text: function(trigger) { return trigger.getAttribute('aria-label'); } });
new ClipboardJS('.btn', { container: document.getElementById('modal') });
var clipboard = new ClipboardJS('.btn'); clipboard.destroy();
如果需要支持更低版本的瀏覽器,可以參考官網(wǎng)的介紹,它能夠優(yōu)雅的降級(jí)
一個(gè)瀏覽器擴(kuò)展,為GitHub,MDN,Gist,StackOverflow,StackExchange,npm甚至Medium中的每個(gè)代碼塊添加“復(fù)制到剪貼板”按鈕。需要的可以私信或者前往擴(kuò)展中心自行下載。
*請(qǐng)認(rèn)真填寫需求信息,我們會(huì)在24小時(shí)內(nèi)與您取得聯(lián)系。