{"_rev":"2-73b45c81f5a18ac6f8b9c422c93b2d83","time":{"created":"2024-10-05T07:25:19.469Z","modified":"2024-10-05T07:25:19.956Z","1.0.0":"2024-10-03T15:22:33.856Z","1.0.1":"2024-10-05T07:25:19.687Z"},"_id":"s-comic-reader","name":"s-comic-reader","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.1":{"name":"s-comic-reader","version":"1.0.1","description":"s-comic-reader，一个漫画阅读插件","main":"scr.min.cjs.js","type":"module","scripts":{"build":"rollup -c"},"repository":{"type":"git","url":"https://gitee.com/hackshendi/s-comic-reader.git"},"keywords":["漫画","漫画阅读","comic","comic reader","下拉式","图片浏览","image preview"],"author":{"name":"砷碲"},"license":"MIT","devDependencies":{"@babel/core":"^7.25.7","@babel/preset-env":"^7.25.7","@rollup/plugin-babel":"^6.0.4","@rollup/plugin-node-resolve":"^15.3.0","@rollup/plugin-terser":"^0.4.4"},"gitHead":"a3217b02712aba5f050d7c2ea2a3547429fb383e","_id":"s-comic-reader@1.0.1","_nodeVersion":"16.14.0","_npmVersion":"8.3.1","dist":{"integrity":"sha512-OsX0+ppXISSppbn1GMjV/A3WI+xUlUF8A1GlJOIDIngB3fW8eBBlRA9ZfYB6zVfGmprHlNF2JqR0l4G5xABgEg==","shasum":"0e41dedb1008e4671144847bc72b4eca1c185a88","tarball":"https://registry.npmjs.org/s-comic-reader/-/s-comic-reader-1.0.1.tgz","fileCount":9,"unpackedSize":46095,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCErbo+lnpco9ZI8luPJBrAwVk7XYZ7uc4Yylnuas1OzwIhAMbnTssefjtpbChTJ9AIsSj23OPkEtvhMxJwtmuAjLvW"}]},"_npmUser":{"name":"shendi","email":"1711680493@qq.com"},"directories":{},"maintainers":[{"name":"shendi","email":"1711680493@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/s-comic-reader_1.0.1_1728113119470_0.14010115622670716"},"_hasShrinkwrap":false}},"maintainers":[{"name":"shendi","email":"1711680493@qq.com"}],"description":"s-comic-reader，一个漫画阅读插件","keywords":["漫画","漫画阅读","comic","comic reader","下拉式","图片浏览","image preview"],"repository":{"type":"git","url":"https://gitee.com/hackshendi/s-comic-reader.git"},"author":{"name":"砷碲"},"license":"MIT","readme":"<br>\r\n\r\n# 漫画阅读器\r\n\r\n也可是图片阅读器，将图片以漫画阅读的方式进行展示。\r\n\r\n**对图片的排列加载等进行封装，不包含菜单栏、标题等定制化内容，可以自行对dom操作添加**\r\n\r\nhttps://gitee.com/hackshendi/s-comic-reader\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n# 引入\r\n\r\n通过npm\r\n\r\n```sh\r\nnpm i s-comic-reader\r\n```\r\n\r\n<br>\r\n\r\n或直接将 `scr.min.js` 文件通过 `script` 标签引入\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n# 起步\r\n\r\n通过 `new SCR()` 来创造一个默认配置的漫画阅读器，传递图片数组使其得以展示\r\n\r\n```js\r\nnew SCR({\r\n    imgs : [\r\n        { url : \"图片1\" },\r\n        { url : \"图片2...\" }\r\n    ]\r\n});\r\n```\r\n\r\n<br>\r\n\r\n执行上面的代码，不出意外的话，图片数组中的图片将在网页最下方依次上下排列，是懒加载的，初次加载 `initNum` 张图片，而后通过滚动触发继续加载。\r\n\r\n<br>\r\n\r\n功能非常简单，一个常见的使用示例如下，用以直接上手。\r\n\r\n> 测试使用的demo代码\r\n\r\n```html\r\n<html>\r\n<head>\r\n</head>\r\n<body>\r\n<div>\r\n        <h1>xxx漫画</h1>\r\n        <input id=\"to\"/>\r\n        <span id=\"page\"></span>\r\n        <button id=\"prev\">上一页</button>\r\n        <button id=\"next\">下一页</button>\r\n        <button id=\"append\">追加</button>\r\n        <div id=\"mh2\" style=\"overflow: auto; height:500px\">\r\n            <div>123456</div>\r\n            <div id=\"mh\">\r\n                <h1>xx漫画</h1>\r\n            </div>\r\n        </div>\r\n        <p>xxx结尾</p>\r\n    </div>\r\n    <script>\r\n        var scr = new SCR({\r\n            el : \"#mh\",\r\n            readType : \"scroll\",\r\n            loadType : \"lazy\",\r\n            scrollEle : document.querySelector(\"#mh2\"),\r\n            preImg : \"https://gips2.baidu.com/it/u=1651586290,17201034&fm=3028&app=3028&f=JPEG&fmt=auto&q=100&size=f600_800\",\r\n            imgs : [\r\n                { url : \"http://gips3.baidu.com/it/u=100751361,1567855012&fm=3028&app=3028&f=JPEG&fmt=auto?w=960&h=1280\" },\r\n                { url : \"http://gips3.baidu.com/it/u=119870705,2790914505&fm=3028&app=3028&f=JPEG&fmt=auto?w=1280&h=720\" },\r\n                { url : \"https://gips3.baidu.com/it/u=3732737575,1337431568&fm=3028&app=3028&f=JPEG&fmt=auto&q=100&size=f1440_2560\" },\r\n                { url : \"ComicReader/2.jpg\" },\r\n                { url : \"ComicReader/3.jpg\" },\r\n                { url : \"ComicReader/4.jpg\" },\r\n                { url : \"ComicReader/5.jpg\" },\r\n                { url : \"ComicReader/6.jpg\" },\r\n                { url : \"ComicReader/7.jpg\" },\r\n                { url : \"ComicReader/8.jpg\" },\r\n                { url : \"ComicReader/9.jpg\" },\r\n                { url : \"ComicReader/10.jpg\" },\r\n                { url : \"ComicReader/11.jpg\" },\r\n                { url : \"ComicReader/12.jpg\" },\r\n                { url : \"ComicReader/13.jpg\" },\r\n                { url : \"ComicReader/14.jpg\" },\r\n                { url : \"ComicReader/15.jpg\" },\r\n                { url : \"ComicReader/16.jpg\" },\r\n                { url : \"ComicReader/17.jpg\" },\r\n                { url : \"ComicReader/18.jpg\" },\r\n                { url : \"ComicReader/19.jpg\" },\r\n                { url : \"ComicReader/20.jpg\" },\r\n                { url : \"ComicReader/21.jpg\" },\r\n                { url : \"ComicReader/22.jpg\" }\r\n            ],\r\n            onImgIndex : function () {\r\n                document.querySelector(\"#page\").innerText = scr.imgIndex;\r\n            },\r\n            imgSuccess : function (img, index, e) {\r\n                console.log(\"加载完成：\", e);\r\n            }\r\n        });\r\n\r\n        document.querySelector(\"#to\").onchange = function () {\r\n            scr.to(this.value);\r\n        };\r\n        document.querySelector(\"#prev\").onclick = function () {\r\n            scr.prev();\r\n        };\r\n        document.querySelector(\"#next\").onclick = function () {\r\n            scr.next();\r\n        };\r\n        document.querySelector(\"#append\").onclick = function () {\r\n            scr.append([\r\n                { url : \"http://gips3.baidu.com/it/u=100751361,1567855012&fm=3028&app=3028&f=JPEG&fmt=auto?w=960&h=1280\" },\r\n                { url : \"http://gips3.baidu.com/it/u=119870705,2790914505&fm=3028&app=3028&f=JPEG&fmt=auto?w=1280&h=720\" },\r\n                { url : \"https://gips3.baidu.com/it/u=3732737575,1337431568&fm=3028&app=3028&f=JPEG&fmt=auto&q=100&size=f1440_2560\" },\r\n                { url : \"ComicReader/2.jpg\" },\r\n                { url : \"ComicReader/3.jpg\" }\r\n            ]);\r\n        };\r\n    </script>\r\n</body>\r\n</html>\r\n```\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n## 左右切换\r\n\r\n除了下拉式阅读，还有左右切换模式，当点击图片左边上一张，右边下一张...\r\n\r\n通过设置 `readType` 为 `lr` 将阅读器设置为左右切换模式\r\n\r\n```js\r\nnew SCR({\r\n    readType : \"lr\",\r\n    imgs : [\r\n        { url : \"图片1\" },\r\n        { url : \"图片2...\" }\r\n    ]\r\n});\r\n```\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n## 在元素中创建\r\n\r\n阅读器默认追加在body末尾，可以通过设置 `el` 属性来指定在哪个元素末尾追加\r\n\r\n```js\r\nnew SCR({\r\n    el : \"#main\",\r\n    imgs : [\r\n        { url : \"图片1\" },\r\n        { url : \"图片2...\" }\r\n    ]\r\n});\r\n```\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n## 加载模式\r\n\r\n提供了全加载(full)与懒加载(lazy)两种模式，通过 `loadType`\r\n\r\n全加载将同时加载 `loadNum` 张图片，加载完成继续加载，直至 `imgs` 中所有元素加载完成。\r\n\r\n懒加载将先加载 `initNum` 张图片，而后根据操作触发懒加载。\r\n\r\n> 触发判定：当页面中剩余图片少于 `offsetNum` 张时，加载 `loadNum` 张图片。\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n## 定位与控制\r\n\r\n定位当前展示图片的位置是常见的需求，阅读器的 `imgIndex` 属性与之一一对应，以及提供了一个 `onImgIndex` 事件，当 `imgIndex` 有更改时触发，可以轻松的实现页数展示\r\n\r\n```js\r\nlet scr = new SCR({\r\n    imgs : [\r\n        { url : \"图片1\" },\r\n        { url : \"图片2...\" }\r\n    ],\r\n    onImgIndex : function () {\r\n        // imgIndex有改变，可以在这里更新页面元素之类的\r\n        // 当前展示页数：scr.imgIndex;\r\n        // 总页数：scr.imgs.length;\r\n    }\r\n});\r\n```\r\n\r\n<br>\r\n\r\n有的时候还有通过按钮控制上一页/下一页的需求，对此也提供了相应的函数\r\n\r\n```js\r\nscr.prev(); // 上一页\r\nscr.next(); // 下一页\r\nscr.to(2); // 第3页\r\n```\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n## 加载状态与重新加载\r\n\r\n每一个 `imgs` 中的元素都会生成相对应的 img 元素，对于图片元素定义了三个状态\r\n\r\n* 加载失败\r\n* 加载完成\r\n* 未加载\r\n\r\n状态保存在 `imgs` 中的元素中，参考 `imgs` 属性\r\n\r\n<br>\r\n\r\n有的时候可能因为网络问题导致加载失败，对此可以通过 `imgError` 事件来处理重新加载，例如\r\n\r\n```js\r\nlet scr = new SCR({\r\n    // ...\r\n    imgSuccess : function (img, index, e) {\r\n        // 图片加载成功触发\r\n    },\r\n    imgError : function (img, index, e) {\r\n        // 图片加载失败触发\r\n        console.log(img, index, e);\r\n        \r\n        // 将图片src更换再换回来实现重新加载\r\n        // 这种方法用于图片一定能加载的情况，否则会一直重新加载，需要增加判断加载失败次数来进行停止\r\n        let src = img.el.src;\r\n        img.el.src = \"\";\r\n        img.el.src = src;\r\n    }\r\n});\r\n```\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n## 预加载与宽高\r\n\r\n有的时候图片过多导致加载缓慢，导致大片空白的情况，这时候可以使用预加载，当图片未加载完成时展示的是预加载图片。\r\n\r\n```js\r\nlet scr = new SCR({\r\n    // ...\r\n    preImg : \"预加载图片url地址\",\r\n    preWidth : \"宽度，同css，例如 100px、100%等\",\r\n    preHeight : \"高度\"\r\n});\r\n```\r\n\r\n<br>\r\n\r\n在阅读器中，图片默认宽度是 `100%`，高度 `auto`，有的时候需要自定义每张图片的宽高，可以如下设置\r\n\r\n```js\r\nlet scr = new SCR({\r\n    // ...\r\n    imgs : [\r\n        {\r\n            url : \"图片1\",\r\n            width : \"100px\",\r\n            height : \"100px\"\r\n            // 以及可以设置当前图片预加载的宽高，优先级高于全局预加载宽高\r\n            preWidth : \"宽度，同css，例如 100px、100%等\",\r\n            preHeight : \"高度\r\n        },\r\n        { url : \"图片2...\" }\r\n    ],\r\n});\r\n```\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n## 追加与更多操作\r\n\r\n阅读器的内容是通过创建对象时传递的，有的时候想要实现连续阅读效果（章节末尾自动追加下一章），可以使用函数 `append` 进行追加\r\n\r\n```js\r\n// 下一章节图片列表\r\nlet imgs = [];\r\n\r\nlet scr = new SCR();\r\nscr.append(imgs);\r\n```\r\n\r\n<br>\r\n\r\n除了追加外，偶尔可能还有其他需求，例如删除某部分...\r\n\r\n对于这种，可以通过操作 `imgs` 属性来实现，例如删除第二个图片元素\r\n\r\n```js\r\nlet scr = new SCR();\r\nlet img = scr.imgs[1];\r\n\r\n// 从 imgs 中移除第二个元素\r\nfor (var i = 1; i < scr.imgs.length - 1; i++) {\r\n    scr.imgs[i] = scr.imgs[i+1];\r\n}\r\n\r\n// 从图片列表中移除图片\r\nscr.els.imgsDiv.removeChild(img);\r\n```\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n# API\r\n\r\n<br>\r\n\r\n## 属性列表\r\n\r\n属性是 `SCR` 类的属性，可在 `new SCR({})`  参数中传递进行初始化，斜体标识的属性除外。\r\n\r\n<br>\r\n\r\n### el\r\n\r\n当前漫画阅读器的父节点，值元素或字符串，如果是字符串，同 `document.querySelector`。\r\n\r\n默认值：document.body\r\n\r\n<br>\r\n\r\n### *els*\r\n\r\n阅读器构建的大体元素列表\r\n\r\n类型：JSON\r\n\r\n| 名称    | class         | 父级元素       | 描述     |\r\n| ------- | ------------- | -------------- | -------- |\r\n| scrDiv  | scr-container | 属性el所指元素 | 根节点   |\r\n| scrCDiv | scr-center    | scrDiv         | 中间节点 |\r\n| imgsDiv | scr-imgs      | scrCDiv        | 图片列表 |\r\n\r\n<br>\r\n\r\n### readType\r\n\r\n阅读类型\r\n\r\n默认值：scroll\r\n\r\n| 名称   | 描述     |\r\n| ------ | -------- |\r\n| lr     | 左右切换 |\r\n| scroll | 下拉式   |\r\n\r\n<br>\r\n\r\n#### 左右切换\r\n\r\n<br>\r\n\r\n#### 下拉式\r\n\r\n##### scrollEle\r\n\r\n滚动元素，是漫画阅读器的父级或祖级元素，用于加载交互等...\r\n\r\n默认值：`window`\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n### loadType\r\n\r\n加载类型\r\n\r\n默认值：lazy\r\n\r\n| 名称 | 描述   |\r\n| ---- | ------ |\r\n| full | 全加载 |\r\n| lazy | 懒加载 |\r\n\r\n<br>\r\n\r\n#### 懒加载\r\n\r\n<br>\r\n\r\n##### initNum\r\n\r\n第一次加载的图片数量\r\n\r\n默认值：5\r\n\r\n<br>\r\n\r\n##### offsetNum\r\n\r\n剩余未读数多少张开始继续加载\r\n\r\n默认值：3\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n### imgs\r\n\r\n图片列表\r\n\r\n默认值：[]\r\n\r\nJSONArray，格式如下\r\n\r\n```json\r\n[\r\n    {\r\n        url : \"图片地址,将于img标签的src对应\",\r\n        el : \"当前元素\",\r\n        state : \"状态，0加载失败，1加载完成，其他为未加载\",\r\n        width : \"可选，图片的宽度，同css的width\",\r\n        heigth : \"可选，图片的高度，同css的height\",\r\n        preWidth : \"可选，当图片还未加载时的宽度，优先级高于属性的preWidth\",\r\n        preHeight : \"可选，当图片还未加载时的宽度，优先级高于属性的preHeight\"\r\n    }\r\n]\r\n```\r\n\r\n<br>\r\n\r\n### *IMG_STATE_SUCCESS*\r\n\r\n图片状态，加载完成\r\n\r\n<br>\r\n\r\n### *IMG_STATE_ERROR*\r\n\r\n图片状态，加载失败\r\n\r\n<br>\r\n\r\n### *imgIndex*\r\n\r\n当前展示的图片在图片列表中的位置，0代表第一张\r\n\r\n默认值：0\r\n\r\n<br>\r\n\r\n### *loadImgIndex*\r\n\r\n当前处理完的图片位置，在处理图片时，不管处理成功或失败，皆+1\r\n\r\n当 `imgs[loadImgIndex] == null` 时，代表imgs中的所有图片处理完成\r\n\r\n默认值：0\r\n\r\n<br>\r\n\r\n### loadNum\r\n\r\n同时加载的数量，如果是1，那么就会等第一张加载完加载第二张，第二张加载完加载第三张...\r\n\r\n如果是懒加载，那么也是每次触发时加载的数量\r\n\r\n默认值：2\r\n\r\n<br>\r\n\r\n### preWidth\r\n\r\n图片未加载时的宽度，值同css\r\n\r\n默认值：无\r\n\r\n<br>\r\n\r\n### preHeight\r\n\r\n图片未加载时的高度，值同css\r\n\r\n默认值：无\r\n\r\n<br>\r\n\r\n### preImg\r\n\r\n图片未加载时的预览图地址，将直接设置为`img`标签的`src`属性\r\n\r\n默认值：无\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n## 函数列表\r\n\r\n属性是 `SCR` 类的函数，一些函数为钩子函数，可在 `new SCR({})`  参数中传递进行初始化，斜体标识的函数除外。\r\n\r\n<br>\r\n\r\n### imgSuccess(img, index, e)\r\n\r\n当图片加载完成时触发\r\n\r\n* img：等同于与属性 img 中的参数一致\r\n* index：所在 img 中的下标，也是当前图片位置\r\n* e：事件\r\n\r\n<br>\r\n\r\n### imgError(img, index, e)\r\n\r\n当图片加载失败时触发\r\n\r\n* img：等同于与属性 img 中的参数一致\r\n* index：所在img中的下标，也是当前图片位置\r\n* e：事件\r\n\r\n<br>\r\n\r\n### *load(index, onload, onerror)*\r\n\r\n加载属性 `imgs` 指定位置的元素并添加到页面末尾。\r\n\r\n* index：imgs中元素的位置\r\n* onload(e)：加载完成时触发，用于继续加载等操作\r\n* onerror(e)：加载失败时触发，用于继续加载等操作\r\n\r\n返回值：加载的img元素\r\n\r\n<br>\r\n\r\n### *prev()*\r\n\r\n上一页\r\n\r\n<br>\r\n\r\n### *next()*\r\n\r\n下一页\r\n\r\n<br>\r\n\r\n### *to(index)*\r\n\r\n定位到指定页，0为第一页。\r\n\r\n<br>\r\n\r\n### *append(imgs)*\r\n\r\n追加图片列表，用于连续章节等。\r\n\r\n* imgs：格式同 `imgs`\r\n\r\n<br>\r\n\r\n### onImgIndex()\r\n\r\n当 `imgIndex` 有变动时触发。\r\n\r\n<br>\r\n\r\n### *getImgIndex()*\r\n\r\n获取图片在 `imgs` 中的位置，与 `imgIndex` 对应，用于下拉式位置重新获取。\r\n\r\n返回值：`imgIndex`\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n### 懒加载\r\n\r\n#### *lazyLoad()*\r\n\r\n懒加载封装，当加载类型以及条件满足时进行加载操作\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n### 阅读类型-左右切换(lr)\r\n\r\n#### leftClick()\r\n\r\n图片左边点击时触发，函数返回值等于true时，意味着默认行为不触发\r\n\r\n默认行为：切换到上一张图片\r\n\r\n<br>\r\n\r\n#### rightClick()\r\n\r\n图片右边点击时触发，函数返回值等于true时，意味着默认行为不触发\r\n\r\n默认行为：切换到下一张图片\r\n\r\n<br>\r\n\r\n<br>\r\n\r\n### 阅读类型-下拉式\r\n\r\n#### *getScrollTop()*\r\n\r\n获取当前滚动元素的顶部滚动位置，用于自定义。\r\n\r\n<br>\r\n\r\n#### *getScrollMaxTop()*\r\n\r\n滚动位置的最大值\r\n\r\n<br>\r\n\r\n#### *getOffsetTop()*\r\n\r\n获取阅读器在滚动条的初始偏移（顶部可能有其他元素占据高度）\r\n\r\n<br>\r\n\r\n#### onscroll()\r\n\r\n滚动事件，当 `el` 滚动时触发，用于自定义滚动事件，在阅读器创建的时会被执行一次，用以初始化。\r\n\r\n默认行为：滚动时重新确定 `imgIndex`，以及支持懒加载行为\r\n\r\n<br>\r\n\r\n<br>","readmeFilename":"README.md"}