CINXE.COM

<!DOCTYPE html><html lang="ja" data-scope-path="layouts/application"><head prefix="og: http://ogp.me/ns# article: http://ogp.me/ns/article#"><link crossorigin="" href="https://www.google-analytics.com/analytics.js" rel="preconnect" /><link rel="preload" href="/fonts/noto-sans-jp-v24-japanese-regular.woff2" as="font" type="font/woff2" crossorigin="anonymous"><link rel="preload" href="/fonts/noto-sans-jp-v24-japanese-700.woff2" as="font" type="font/woff2" crossorigin="anonymous"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-25666851-3"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-25666851-3'); </script> <link rel="stylesheet" media="all" href="/assets/ress-d1ba3a251927ab1f2bcc841c9a810109355bcb4260a522a0f76452fdc2fe6095.css" /><link rel="stylesheet" media="all" href="/assets/scopes/layouts/application-dda4ec688c139c8f29c39a2a795bcf4af04c4326643549a37f5d8843fffaebab.css" /><link rel="stylesheet" media="all" href="/assets/scopes/articles/show-37905516c06229c8fde10714e660fc48bc7b6ce7881755707db8b0327ceb5bf1.css" /><link rel="stylesheet" media="all" href="/assets/scopes/partials/_viewer-3a78a10250bb498047a06b71271b62ea949e304d25b9781c4450cf998aa2640c.css" /><link rel="stylesheet" media="all" href="/assets/scopes/layouts/_header-db87b54171cc020758ab7d1494677f8f6c2e9c93b453e896af82e4814eaacc7c.css" /><link rel="stylesheet" media="all" href="/assets/scopes/layouts/_breadcrumbs-744a099ab0b9eb5c4bd45215617e267c7d7c404ddddce8810eead5335512e637.css" /><link rel="stylesheet" media="all" href="/assets/scopes/layouts/_footer-a06961717440c6d0183c582c7f21768011f334d368f51b614eabc87bb17b3bbf.css" /><script src="/packs/application-02365dbc4dc28919eee1.js" defer="defer"></script><link href="/icon.png" rel="icon" type="image/png" /><link href="/apple-touch-icon.png" rel="apple-touch-icon" type="image/png" /><link href="/feed" rel="alternate" title="RSS2.0" type="application/rss+xml" /><title>Turbo Frame の表示切り替えを検知する | Basicinc Enjoy Hacking!</title><meta name="csrf-param" content="authenticity_token" /> <meta name="csrf-token" content="ehagKwuJiV5TuYpK6SyBtAgVFiNG5ekYsYjmhVPgL+r29so4a8WbXyELTA6nadpmHIvbjbfqfekTRRT/YGPjSw==" /><meta content="width=device-width,initial-scale=1" name="viewport" /><meta content="Turbo Frame の表示切り替えを検知する | Basicinc Enjoy Hacking!" property="og:title" /><meta content="article" property="og:type" /><meta content="2021-04-14T08:59:09+09:00" property="article:published_time" /><meta content="2021-04-21T09:28:29+09:00" property="article:modified_time" /><meta content="zaru" property="article:author" /><meta content="Technology" property="article:section" /><meta content="https://tech.basicinc.jp/articles/215" property="og:url" /><meta content="https://tech.basicinc.jp/assets/default_eyecatch-9e0d94e7defd5e124532d0b790a8f8cccfdffa0aed4581afa5f932cfec0b39a2.png" property="og:image" /><meta content="image/png" property="og:image:type" /><meta content="1200" property="og:image:width" /><meta content="630" property="og:image:height" /><meta content="2021/04/21 追記 Turbo Frame のリファレンスをよく見たら load イベント時のコールバックを設定できました。 export default class extends Controller { static targets = [ 'frame' ]..." property="og:description" /><meta content="ja_JP" property="og:locale" /><meta content="summary" name="twitter:card" /><meta content="@zaru" name="twitter:creator" /></head><body><header data-scope-path="layouts/_header"><div class="header-contents"><a class="root-link" href="/"><svg class="site-logo"><use xlink:href="/assets/icons-5bbe775037b55281ef0bc50d30a51f69c7c3914d399c7107e37f0702d98ae8a2.svg#logo"></use></svg><div class="site-title">Enjoy Hacking!</div></a><div class="site-desc">Basicinc エンジニアブログ</div></div></header><nav data-scope-path="layouts/_breadcrumbs"><ul class="breadcrumbs" itemscope="itemscope" itemtype="https://schema.org/BreadcrumbList">% cat <li itemprop="itemListElement" itemscope="itemscope" itemtype="https://schema.org/ListItem"><a itemprop="item" href="/">~</a><meta itemprop="position" content="1" /></li>/<li class="current" itemprop="itemListElement" itemscope="itemscope" itemtype="https://schema.org/ListItem">TurboFrameの表示切り替えを検知する.md<meta itemprop="item" content="https://tech.basicinc.jp/articles/215" /><meta itemprop="position" content="2" /></li></ul></nav><div data-scope-path="articles/show"><article class="article"><h1 class="article-title">Turbo Frame の表示切り替えを検知する</h1><div class="article-desc"><a class="article-author" href="/authors/1"><img class="article-author-avatar" src="https://tech.basicinc.jp/uploads/e868e5fb1e34b970ae7d8e04c454ff28.png" />zaru</a><div class="article-date-info"><time class="article-posted-date with-separator">Posted 2021-04-14</time><time class="article-revised-date">Revised 2021-04-21</time></div></div><div class="article-body"><div data-scope-path="partials/_viewer">2021/04/21 追記 Turbo Frame のリファレンスをよく見たら <code>load</code> イベント時のコールバックを設定できました。 <pre lang="javascript" class="highlight highlight-javascript">export default class extends Controller { static targets = [ 'frame' ]; connect() { this.frameTarget.loaded.then(() => { // do something... }); } } </pre> これで Turbo Frame の読み込みが完了したタイミングで任意の処理を実行することが出来ます。 追記ここまで <hr> Hotwire の Turbo Frame は現時点の最新バージョン ( v7.0.0-beta.5 ) では Trubo Frame の表示イベントは存在しません（ただ対応プルリクは出ているので、将来的にはサポートされるかもしれません）。 Turbo Frame はページ内の一部を非同期に表示させる機能なので、表示切り替え時にフェードイン・アウトや、読み込みインジケーターを表示させたりがしたくなります。というわけで、今回は Turbo Frame の表示切り替えを検知して任意の処理をできるようにします。 さっそく実現するためのコードです。やっていることは原始的で Stimulus のコントローラで Turbo Frame タグを MutationObserver 使って変更監視するだけです。Turbo Frame はコンテンツの読み込み時には <code>busy</code> 属性をつけてくれるので、<code>busy</code> 属性の変更を検知することで読み込み中・読み込み完了を知ることができます。 <pre lang="javascript" class="highlight highlight-javascript">import { Controller } from 'stimulus'; export default class extends Controller { static targets = [ 'frame' ]; connect () { this.observer = new MutationObserver(this.frameMutated.bind(this)); this.observer.observe(this.frameTarget, { attributes: true }); } disconnect () { this.observer.disconnect(); delete this.observer; } frameMutated () { if (this.frameTarget.hasAttribute('busy')) { console.log('loading...'); } else { console.log('ready!'); } } } </pre> <pre lang="erb" class="highlight highlight-erb"><%= turbo_frame_tag 'frame_detail', data: { controller: 'frame', frame_target: 'frame' } %> <%= link_to 'Show', hoge_path, data: { turbo_frame: 'frame_detail' } %> </pre> 簡単ですね。</div></div><div class="article-sns-share-buttons"><a rel="nofollow" target="_blank" class="pocket-share sns-share-button" href="http://getpocket.com/edit?title=Turbo+Frame+%E3%81%AE%E8%A1%A8%E7%A4%BA%E5%88%87%E3%82%8A%E6%9B%BF%E3%81%88%E3%82%92%E6%A4%9C%E7%9F%A5%E3%81%99%E3%82%8B+by+zaru+%7C+Basicinc+Enjoy+Hacking%21&url=https%3A%2F%2Ftech.basicinc.jp%2Farticles%2F215"><svg class="sns-icon pocket-icon"><use xlink:href="/assets/icons-5bbe775037b55281ef0bc50d30a51f69c7c3914d399c7107e37f0702d98ae8a2.svg#pocket"></use></svg></a><a rel="nofollow" target="_blank" class="hatena-share sns-share-button" href="http://b.hatena.ne.jp/add?mode=confirm&title=Turbo+Frame+%E3%81%AE%E8%A1%A8%E7%A4%BA%E5%88%87%E3%82%8A%E6%9B%BF%E3%81%88%E3%82%92%E6%A4%9C%E7%9F%A5%E3%81%99%E3%82%8B+by+zaru+%7C+Basicinc+Enjoy+Hacking%21&url=https%3A%2F%2Ftech.basicinc.jp%2Farticles%2F215"><svg class="sns-icon hatena-icon"><use xlink:href="/assets/icons-5bbe775037b55281ef0bc50d30a51f69c7c3914d399c7107e37f0702d98ae8a2.svg#hatena"></use></svg></a><a rel="nofollow" target="_blank" class="twitter-share sns-share-button" href="https://twitter.com/share?text=Turbo+Frame+%E3%81%AE%E8%A1%A8%E7%A4%BA%E5%88%87%E3%82%8A%E6%9B%BF%E3%81%88%E3%82%92%E6%A4%9C%E7%9F%A5%E3%81%99%E3%82%8B+by+zaru+%7C+Basicinc+Enjoy+Hacking%21&url=https%3A%2F%2Ftech.basicinc.jp%2Farticles%2F215"><svg class="sns-icon twitter-icon"><use xlink:href="/assets/icons-5bbe775037b55281ef0bc50d30a51f69c7c3914d399c7107e37f0702d98ae8a2.svg#twitter"></use></svg></a><a rel="nofollow" target="_blank" class="facebook-share sns-share-button" href="http://www.facebook.com/share.php?u=https%3A%2F%2Ftech.basicinc.jp%2Farticles%2F215"><svg class="sns-icon facebook-icon"><use xlink:href="/assets/icons-5bbe775037b55281ef0bc50d30a51f69c7c3914d399c7107e37f0702d98ae8a2.svg#facebook"></use></svg></a></div></article></div><footer data-scope-path="layouts/_footer"><div class="footer-contents"><a class="root-link" href="/"><svg class="site-logo"><use xlink:href="/assets/icons-5bbe775037b55281ef0bc50d30a51f69c7c3914d399c7107e37f0702d98ae8a2.svg#logo"></use></svg><div class="site-title">Enjoy Hacking!</div></a><ul class="link-list"><li class="link-list-item"><a class="link" href="https://basicinc.jp/" rel="noopener" target="_blank">株式会社ベーシック</a></li><li class="link-list-item"><a class="link" href="https://basicinc.jp/enjoy-hacking" rel="noopener" target="_blank">エンジニア募集</a></li><li class="link-list-item"><a class="link" href="https://qiita.com/organizations/basicinc" rel="noopener" target="_blank">Qiita</a></li><li class="link-list-item"><a class="link" href="https://www.wantedly.com/companies/basicinc/projects" rel="noopener" target="_blank">Wantedly</a></li></ul></div></footer></body></html>