开胃小菜——impress.js代码详解

README

友谊提醒,下面有大量代码,由于网页上代码显示都是与一个颜料,所以推举大家复制到祥和之代码编辑器中扣。

今天闲来无事,研究了扳平西impress.js的源码。由于事先研究过jQuery,看impress.js并不曾撞最老之阻碍,读代码用了一个时,写就首稿子之所以了临近三个小时,果然写篇于读代码费劲多矣。

个人感觉impress.js的代码量(算上注释一共不顶1000实践)和难度(没有jQuery的各种black
magic
= =)都非常适合新手上,所以写一个总结,帮助大家掌握源码。

考虑到多情人并无喜欢深入细节,下文分为四有些:

  • 函数目录:汇总所有函数及其作用,方便查看
  • 事件分析:了解impress.js的运转基础
  • 流程分析:了解impress.js的运作流程
  • 克代码:具体到行的代码讲解

眼前三有些是必看的,最后一有的可依据个人兴趣选择。由于自己看代码一向爱抠细节,在我看来细节才是最最能提高能力而最好有趣的地方,所以我会把每行代码甚至每个变量每个表达式都开口明白,让您真正的看懂impress.js。

是因为最后一节省会写详细说明,所以前面几节约吃出现的代码我弗见面详细分解,只会证明大概的效益,方便大家清楚。对细节感兴趣之爱人可扣押最终一节约。

函数目录

公可暂时先跳过即时无异节省或者简单浏览一下,后面看代码的时段可以更来查函数作用。

函数名 函数作用
pfx 给css3属性加上当前浏览器可用的前缀
arrayify 将Array-Like对象转换成Array对象
css 将指定属性应用到指定元素上
toNumber 将参数转换成数字,如果无法转换返回默认值
byId 通过id获取元素
$ 返回满足选择器的第一个元素
$$ 返回满足选择器的所有元素
triggerEvent 在指定元素上触发指定事件
translate 将translate对象转换成css使用的字符串
rotate 将rotate对象转换成css使用的字符串
scale 将scale对象转换成css使用的字符串
perspective 将perspective对象转换成css使用的字符串
getElementFromHash 根据hash来获取元素,hash就是URL中形如#step1的东西
computeWindowScale 根据当前窗口尺寸计算scale因子,用于放大和缩小
empty 什么用都没有的函数,当浏览器不支持impress的时候会用到,一点用都没有
impress 主函数,构造impress对象,这是一个全局对象
onStepEnter 用于触发impress:stepenter事件
onStepLeave 用于触发impress:stepleave事件
initStep 初始化给定step
init 主初始化函数
getStep 获取指定step
goto 切换到指定step
prev 切换到上一个step
next 切换到下一个step
throttle 可以延后运行某个函数

事件分析

先知道一个基本概念——step。
step就是impress.js画布中的着力单位,一个step就是同幕,你按照平涂鸦键盘上的←键或者→键就见面切换一次等step。

事件是impress.js运行的基本功,共有三个,分别是impress:init,
impress:stepenterimpress:stepleave(下文将省略impress前缀)。

init凡初始化事件,stepenter是上下同样步事件,stepleave大凡离开上一致步事件。

init事件就于初始化时候接触,且仅给硌一赖,因为impress.js内部有一个initialized变量,初始化之后是变量会置True,从而确保单独初始化一不良。
产同样省吃我们会详细讲解init事件,这里少跳了。

那么stepenterstepleave发啊用吗?
苟我们今天处第1步,我们仍一下键盘上之→键就见面切换至第2步,这背后impress.js实际上触发了少于个事件:stepleavestepenter,夹在简单只事件当中的就算是css的动画效果。也就是说,先点stepleave事件,然后运行css动画,然后触发stepenter。这半只事件的打算主要就是是设定有标志位和变量,比如安当前活蹦乱跳step。

流程分析

impress对象暴露了季只API,分别是goto(), init(), next(),
prev()。由于next()prev()犹是根据goto()形容的,所以我们下要分析goto()init()

impress.js的运行流程可以分为两大组成部分——初始化过程以及step切换过程,正好对应init()goto()。就像面说交之。初始化过程只有见面给运行一坏,而切换过程或者吃触发很多次。

我们事先来分析重点——初始化过程

初始化过程分成两独号,第一独阶段是运作init()函数,第二单等级是运行绑定到impress:init齐之函数。这片独号之间的总是非常简单,就是以init()函数的末尾触发impress:init事件,这样绑定上去的函数就见面全体碰了。

来看望init()函数都干了什么:

var init = function () {
    if (initialized) { return; }

    // 首先设定viewport
    var meta = $("meta[name='viewport']") || document.createElement("meta");
    meta.content = "width=device-width, minimum-scale=1, maximum-scale=1, user-scalable=no";
    if (meta.parentNode !== document.head) {
        meta.name = 'viewport';
        document.head.appendChild(meta);
    }

    // 初始化config对象
    var rootData = root.dataset;
    config = {
        width: toNumber( rootData.width, defaults.width ),
        height: toNumber( rootData.height, defaults.height ),
        maxScale: toNumber( rootData.maxScale, defaults.maxScale ),
        minScale: toNumber( rootData.minScale, defaults.minScale ),                
        perspective: toNumber( rootData.perspective, defaults.perspective ),
        transitionDuration: toNumber( rootData.transitionDuration, defaults.transitionDuration )
    };

    // 计算当前scale
    windowScale = computeWindowScale( config );

    // 将所有step放到canvas中,再将canvas放到root中。
    // 注意这里的canvas和css3中的canvas没关系,这里的canvas只是一个div
    arrayify( root.childNodes ).forEach(function ( el ) {
        canvas.appendChild( el );
    });
    root.appendChild(canvas);

    // 设置html元素的初始高度
    document.documentElement.style.height = "100%";

    // 设置body元素的初始属性
    css(body, {
        height: "100%",
        overflow: "hidden"
    });

    // 设置根元素的初始属性
    var rootStyles = {
        position: "absolute",
        transformOrigin: "top left",
        transition: "all 0s ease-in-out",
        transformStyle: "preserve-3d"
    };

    css(root, rootStyles);
    css(root, {
        top: "50%",
        left: "50%",
        transform: perspective( config.perspective/windowScale ) + scale( windowScale )
    });
    css(canvas, rootStyles);

    // 不能确定impress-disabled类是否存在,所以先remove一下
    body.classList.remove("impress-disabled");
    body.classList.add("impress-enabled");

    // 获取所有step并初始化他们
    steps = $$(".step", root);
    steps.forEach( initStep );

    // 设置canvas的初始状态
    currentState = {
        translate: { x: 0, y: 0, z: 0 },
        rotate:    { x: 0, y: 0, z: 0 },
        scale:     1
    };

    initialized = true;

    // 触发init事件
    triggerEvent(root, "impress:init", { api: roots[ "impress-root-" + rootId ] });
};

init()函数搞明白了,下面我们分析第二路:运行绑定到impress:init事件及的函数。
来看看impress:init事件方都绑定了啊函数:

root.addEventListener("impress:init", function(){
    // 改变step当前状态
    steps.forEach(function (step) {
        step.classList.add("future");
    });

    root.addEventListener("impress:stepenter", function (event) {
        event.target.classList.remove("past");
        event.target.classList.remove("future");
        event.target.classList.add("present");
    }, false);

    root.addEventListener("impress:stepleave", function (event) {
        event.target.classList.remove("present");
        event.target.classList.add("past");
    }, false);

}, false);

// 处理hash相关操作
root.addEventListener("impress:init", function(){

    var lastHash = "";
    root.addEventListener("impress:stepenter", function (event) {
        window.location.hash = lastHash = "#/" + event.target.id;
    }, false);

    window.addEventListener("hashchange", function () {
        if (window.location.hash !== lastHash) {
            goto( getElementFromHash() );
        }
    }, false);

    goto(getElementFromHash() || steps[0], 0);
}, false);

// 绑定键盘事件、触摸事件和点击事件
document.addEventListener("impress:init", function (event) {
    var api = event.detail.api;

    // 绑定键盘事件
    document.addEventListener("keydown", function ( event ) {
        if ( event.keyCode === 9 || ( event.keyCode >= 32 && event.keyCode <= 34 ) || (event.keyCode >= 37 && event.keyCode <= 40) ) {
            event.preventDefault();
        }
    }, false);

    document.addEventListener("keyup", function ( event ) {
        if ( event.keyCode === 9 || ( event.keyCode >= 32 && event.keyCode <= 34 ) || (event.keyCode >= 37 && event.keyCode <= 40) ) {
            switch( event.keyCode ) {
                case 33: // pg up
                case 37: // left
                case 38: // up
                         api.prev();
                         break;
                case 9:  // tab
                case 32: // space
                case 34: // pg down
                case 39: // right
                case 40: // down
                         api.next();
                         break;
            }

            event.preventDefault();
        }
    }, false);

    // 绑定链接点击事件
    document.addEventListener("click", function ( event ) {
        var target = event.target;
        while ( (target.tagName !== "A") &&
                (target !== document.documentElement) ) {
            target = target.parentNode;
        }

        if ( target.tagName === "A" ) {
            var href = target.getAttribute("href");

            // if it's a link to presentation step, target this step
            if ( href && href[0] === '#' ) {
                target = document.getElementById( href.slice(1) );
            }
        }

        if ( api.goto(target) ) {
            event.stopImmediatePropagation();
            event.preventDefault();
        }
    }, false);

    // 绑定对象点击事件
    document.addEventListener("click", function ( event ) {
        var target = event.target;
        while ( !(target.classList.contains("step") && !target.classList.contains("active")) &&
                (target !== document.documentElement) ) {
            target = target.parentNode;
        }

        if ( api.goto(target) ) {
            event.preventDefault();
        }
    }, false);

    // 绑定触摸事件
    document.addEventListener("touchstart", function ( event ) {
        if (event.touches.length === 1) {
            var x = event.touches[0].clientX,
                width = window.innerWidth * 0.3,
                result = null;

            if ( x < width ) {
                result = api.prev();
            } else if ( x > window.innerWidth - width ) {
                result = api.next();
            }

            if (result) {
                event.preventDefault();
            }
        }
    }, false);

    // 绑定页面resize事件
    window.addEventListener("resize", throttle(function () {
        api.goto( document.querySelector(".step.active"), 500 );
    }, 250), false);

}, false);

俺们来梳理一方方面面,初始化过程做了呀事:

  • init()函数中要初始化画布、step以及impress对象中用到的局部态
  • 绑定到impress:init事件上的函数把其余急需绑定的风波都进行了绑定,让impress可以正常办事

连通下我们分析step切换过程,来探望goto函数都涉嫌了啊

好家伙?你生出硌累了?加把劲2018正版葡京赌侠诗,一定要看罢goto

var goto = function ( el, duration ) {

    if ( !initialized || !(el = getStep(el)) ) {
        //如果没初始化或者el不是一个step就返回
        return false;
    }

    // 为了避免载入时候浏览器滚动,手动滚动到0,0
    window.scrollTo(0, 0);

    var step = stepsData["impress-" + el.id];

    // 清理当前活跃step上面的标记
    if ( activeStep ) {
        activeStep.classList.remove("active");
        body.classList.remove("impress-on-" + activeStep.id);
    }
    // 给el加活跃标记
    el.classList.add("active");

    body.classList.add("impress-on-" + el.id);

    // 计算canvas相对于当前step的变换参数
    var target = {
        rotate: {
            x: -step.rotate.x,
            y: -step.rotate.y,
            z: -step.rotate.z
        },
        translate: {
            x: -step.translate.x,
            y: -step.translate.y,
            z: -step.translate.z
        },
        scale: 1 / step.scale
    };

    // 处理缩放
    var zoomin = target.scale >= currentState.scale;

    duration = toNumber(duration, config.transitionDuration);
    var delay = (duration / 2);

    // 如果el就是当前活跃step,重新计算scale
    if (el === activeStep) {
        windowScale = computeWindowScale(config);
    }

    var targetScale = target.scale * windowScale;

    // 触发stepleave事件
    if (activeStep && activeStep !== el) {
        onStepLeave(activeStep);
    }

    // 这里就是最核心的部分,设置css来实现动画效果
    // 需要注意的是,动画效果有两类:缩放和移动
    // 为了让效果看起来更逼真,这两类动画是分开实现的
    // 缩放应用在root上,移动应用在canvas上
    // 大家还记得元素的结构吗?root下面是canvas,canvas下面是所有step
    // 所以缩放root的时候其实就是缩放canvas
    // 至于为什么分开可以更逼真,请看最后一节的代码详解

    // 这里是把缩放应用到root上
    css(root, {
        transform: perspective( config.perspective / targetScale ) + scale( targetScale ),
        transitionDuration: duration + "ms",
        transitionDelay: (zoomin ? delay : 0) + "ms"
    });

    // 这里就是把移动应用到canvas上
    css(canvas, {
        transform: rotate(target.rotate, true) + translate(target.translate),
        transitionDuration: duration + "ms",
        transitionDelay: (zoomin ? 0 : delay) + "ms"
    });

    if ( currentState.scale === target.scale ||
        (currentState.rotate.x === target.rotate.x && currentState.rotate.y === target.rotate.y &&
         currentState.rotate.z === target.rotate.z && currentState.translate.x === target.translate.x &&
         currentState.translate.y === target.translate.y && currentState.translate.z === target.translate.z) ) {
        delay = 0;
    }

    // 存储当前状态
    currentState = target;
    activeStep = el;

    // 动画执行完毕后触发stepenter事件
    window.clearTimeout(stepEnterTimeout);
    stepEnterTimeout = window.setTimeout(function() {
        onStepEnter(activeStep);
    }, duration + delay);

    return el;
};

吓了,下面简单看看prev和next函数:

var prev = function () {
    var prev = steps.indexOf( activeStep ) - 1;
    prev = prev >= 0 ? steps[ prev ] : steps[ steps.length-1 ];

    return goto(prev);
};

var next = function () {
    var next = steps.indexOf( activeStep ) + 1;
    next = next < steps.length ? steps[ next ] : steps[ 0 ];

    return goto(next);
};

生简短吧?他们都是依据goto写的,所以基本的goto搞懂了也便亮prev和next了。

克代码

非常感谢你能收看此间——或者是一直跨越到此地——这首文章大概是本人写了之尽丰富的文章了,如果你当不错的话语请点单“喜欢”点个“分享”吧!

自想都勾及简书里之,但是写到这里的言辞会为本就很丰富之文章变得再增长。。。所以即便将代码详解写成了一个Gist,感兴趣的朋友可以看看:
代码详解

相关文章