Skip to content

このサンプルコードを用いることで、Web Chatにおいて file:// からはじまるリンクをレンダリングすることができます。You can set hyperlink of file:// on WebChat by using this sample code.

License

Notifications You must be signed in to change notification settings

compulim/WebChatUI-MarkedSample

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

WebChatUI-MarkedSample

このサンプルコードを用いることで、Web Chatにおいて file:// からはじまる文字列に対してハイパーリンクを設定することができます。

背景

Web ChatのUIを制御しているデフォルトのエンジンとして、markdown-itというものが使用されています。Web Chatでは、markdown-itの初期設定において file:// から始まる文字列を、セキュリティの問題から、単なる文字列として出力することになっています(QnA Makerで登録したマークダウンが file:// に対しては適応されません)。そのため、file:// に対してWeb Chat上でハイパーリンクを付ける場合には、レンダリングエンジンの設定を変える必要があります。

本サンプルについて

このサンプルではレンダリングエンジンとして、Markedを採用しています。また、サニタイジング処理も書かれています。ローカルファイルやファイルサーバ上のファイルリンクを特別な都合上ボットに載せたいという要求がある時のみ使用すべきサンプルと考えて頂き、セキュリティの管理に関しては、ご使用者様のご責任でお願いいたします。

動作環境

Google Chrome, Microsoft Edge, Internet Explorer 11 で動作を確認済みです。

使用方法

  1. Azureポータルでボットのチャネル設定から、Direct Lineを選択し、発行されるキーをコピーしてください。

  1. index.htmlの28行目 YOUR_SECRET_KEY を消し、コピーしたキーを貼り付けてください。

  1. 動作をローカル環境でご確認後、Azure Web Appのwwwroot配下に作成したindex.htmlを配置してください。

  1. 動作確認をお願いします。

留意事項

本サンプルを用いることで file:// に対してもWeb Chatでハイパーリンク表示をさせることができますが、その後ユーザがファイルを直接ダウンロードできるかどうかの設定はブラウザ側の設定になります。Chromeではローカルファイルをダウンロードするための拡張機能が提供されておりますが、セキュリティの都合上採用できないという場合には、ボット側のUIで、ユーザにリンクをコピーすることを促すようなデザインを作る必要があるかと思います。

Special Thanks

This sample code was created by William-san(https://github.com/compulim), a software engineer developing Web Chat. Corina-san(https://github.com/corinagum) also gave us some advice and it was really helpful. Thank you so much!

About

このサンプルコードを用いることで、Web Chatにおいて file:// からはじまるリンクをレンダリングすることができます。You can set hyperlink of file:// on WebChat by using this sample code.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 100.0%