1.0.8 • Published 2 years ago

msbox v1.0.8

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

MSBox

MSBoxはシンプルなモーダル表示のjsライブラリです。

使用方法

npmでのダウンロード

$ npm i msbox

ファイル読み込み

css読み込み

<link rel="stylesheet" href="./src/css/msbox.min.css">

JavaScript読み込み

<script src="./src/js/msbox.js"></script>

node.jsを使用して読み込み

window.MSBox = require('msbox');

最もシンプルなモーダル表示方法

<script>
  let msbox = new MSBox();
  msbox.open();
</script>

デフォルトでは画面全体を覆うようにして、モーダルが表示されます。

モーダルの内容変更

<script>
  let msbox = new MSBox({
      contentHtml: '<span>始めまして、S-MSBox!!</span>',
  });
  msbox.open();
</script>

contentHtmlオプションにHTML要素を設定することで、そのHTML要素をモーダル内に表示可能です。

対象DOM要素を覆うモーダル表示方法

<div id="target" style="position: relative;">
    適用範囲
</div>
<script>
  let msbox = new MSBox({
      target: $('#target'),
      position: 'absolute',
  });
  msbox.open();
</script>

オプションとしてtargetを指定することで、その対象DOM要素を覆うようなモーダルを表示できます。
※この際、対象DOM要素のpositionを'relative'、MSBoxのpositionオプションを'absolute'とする必要があります。

targetの指定方法① 直接COM要素指定

let msbox = new MSBox({
    target: document.getElementById('target'),
    position: 'absolute',
});

上記の様に直接DOM要素を指定できます。

targetの指定方法② jQuery要素指定

let msbox = new MSBox({
    target: $('#target'),
    position: 'absolute',
});

上記の様にjQuery要素を指定できます。

targetの指定方法③ idを指定

let msbox = new MSBox({
    target: '#target',
    position: 'absolute',
});

上記の様にidセレクタを用いて指定できます。

Methods

以下のmethodが使用可能です。

method内容引数戻り値
open()モーダルを開く無しMSBox
close()モーダルを閉じる無しMSBox
setOption(options)モーダルのoptionを更新optionsMSBox
init(options)モーダル自身やoptionを初期化optionsMSBox
detach()モーダルDOM要素を削除無しMSBox
destroy()detach() and init()無しMSBox

Options

以下のoptionが設定可能です。

option内容デフォルト
positionモーダル要素のposition'fixed'
targetモーダルが表示される要素document.querySelector('html body')
animationモーダルが表示時のアニメーションの有無true
animationTimeモーダルが表示時のアニメーション時間(ms)200
headerTitleモーダルのヘッダータイトル'Hello MSBox'
contentHtmlモーダルコンテンツ内容'Hello World'
widthモーダル幅'50%'
heightモーダル高さ'50%'
zIndexモーダル全体(透過背景も含む)のz-indexnull
draggableモーダルをドラッグで移動可能かfalse
headerShowモーダルのヘッダーを表示するかどうかtrue
closeBtnShow閉じるボタンを表示するかどうかtrue
onOpenモーダルが開く直前の処理function(){}
onOpenedモーダルが開いた直後の処理function(){}
onCloseモーダルが閉じる直前の処理function(){}
onClosedモーダルが閉じた直後の処理function(){}
1.0.8

2 years ago

1.0.7

3 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

0.0.1

3 years ago