CHANGELOG.md

3.38.2 (2024-06-20)

Bug Fixes

• 修复缺陷 - issues(#47) - 配置参数 showCode 默认值调整为：false (5bba55f)
• 修复缺陷 - issues(#45) - 兼容问题，默认 scrollElement = 'html,body' 在老版本 chrome(Chromium 60.0.3112.113)以下需要手动设置为 ‘body’ (68c6ffa)

3.38.1 (2024-05-24)

Bug Fixes

• 修复 ES6 语法 扩展运算符（spread）在低版本浏览器中的兼容性问题； (afdae86)
• 修复使用语音阅读时，推出阅读模式，未关闭语音阅读的问题； (fdacca6)

Features

• 优化交互体验，给工具栏按钮添加缩放动画效果； (5ddadb0)

3.38.0 (2024-04-18)

Bug Fixes

• 修复调整 getChaptersByHeadings() 方法逻辑后，设置显示编码，导航菜单会显示重复的编码问题； (ee4ee83)

Features

• 调整 Navigator 模块的绘制逻辑，展开时添加 outline-navigator_expanded 样式表示展开样式 (bf7a61e)
• 添加 isExpanded()、expand() 和 collapses() 方法，并添加 API 文档； (64c3f0b)

3.37.0 (2024-04-17)

Features

• 更新阅读模式工具栏图标样式和排列顺序 (172810f)
• 针对部分支持 ScrollTimeline 的移动设备添加阅读模式的阅读滚动进度条动画 (e3e6375)

3.36.1 (2024-04-16)

Bug Fixes

• 修复阅读模式在移动设备的显示问题； (9c6ccb6)

3.36.0 (2024-04-16)

Features

• 调整阅读模式的样式，并优化样式代码； (70da824)
• 优化阅读模式在移动设备中的显示效果； (3de1e90)

3.35.2 (2024-04-08)

Bug Fixes

• 修复 position: 'relative' 定位，导航菜单与文档滚动位置无法同步的问题； (69ac8bf)
• 修复仅高亮定位当前标题时，文章滚动到导航菜单在 viewport 中无法看到的章节，无法自动定位的问题； (84a032a)

Features

• 调整 anchors.js 模块，调整绘制逻辑 (307ee81)
• 调整模块名称，将 chapters.js 调整为 navigator.js，并更新样式和 API 文档； (fbd5ee8)

3.35.1 (2024-04-01)

Bug Fixes

• 修复 Speech 模块，初始化逻辑错误导致阅读文档报错 (0eb6837)

3.35.0 (2024-04-01)

Features

• 调整 reader.js 模块，使用 toolbar 模块生成工具栏按钮； (16f08e1)
• 添加 reader.allowSpeak 配置，用以配置是否启用 Web Speech API 阅读文章 (1611cd6)
• 完善 speech.js 模块，并给 reader.js 模块添加 speak() 方法用以阅读文章； (be6eef8)
• 阅读模式添加打印功能按钮；调整打印样式，隐藏调整后的阅读模式 toolbar 的显示； (482e84e)
• 阅读模式添加滚动阅读进度条交互； (ceee986)

3.34.2 (2024-03-23)

Bug Fixes

• 调整 base.js 模块中的 reload() 方法的实现，修复 reload() 方法报错的问题；
• 修复 toolbar.js 模块中 highlight() 方法无效的错误； (a00b155)

3.34.1 (2024-03-22)

Bug Fixes

• 修复 outline.js 中处理 _default() 方法的错误； (4bffd05)

3.34.0 (2024-03-22)

Bug Fixes

• 修复 navigator.js 模块中 removeListeners() 方法中移除 window.resize 事件的错误逻辑 (d1f4eb7)
• 修复问题-添加缺失的 destroyed 事件； (0afd149)

Features

• 调整 toolbar.js 模块，接入命令模式保存按钮命令，并且添加 execute() 方法；调整 outline.js 模块中关于工具栏命令配置的逻辑； (5e52ee5)
• outline.js 模块添加 $scrollElement 属性，并添加其 API 文档说明； (d8caae4)

3.33.0 (2024-03-12)

Features

• 文章大纲导航的滚动条会随文章正文滚动位置同步滚动，使大纲导航的当前章节始终可见；

3.32.3 (2024-03-08)

Bug Fixes

• 修复缺陷-issues(#43)，添加 @babel/plugin-proposal-optional-chaining 插件，转化ES6 的可选链操作符语法，获得更好的浏览器兼容性；

3.32.1 (2024-03-06)

Bug Fixes

• 修复 Anchors 模块初始化 attrs 属性直接复制等于 Anchors.DEFAULTS 在创建多个实例时出现的共用一个配置的问题；

3.32.0 (2024-03-05)

Features

• 调整 print 参数名为 reader；
• 重构原来的 print.js 调整为 Reader 模块；
• 添加 refresh() 方法；公开 enterReading()、exitReading() 和 switchReading() 方法；
• 更新 API 文档；

3.31.0 (2024-02-27)

Features

• 添加新的配置：closeOnClickModal 和 showNavModalFirst，用以解决 issues(#41) 中的问题 (0cb173a)

3.30.4 (2024-01-23)

Bug Fixes

• 修复文章无标题标签 anchors.js 和 navigator.js 子组件事件绑定的逻辑错误导致的报错； (c853bb1)

3.30.3 (2024-01-17)

Bug Fixes

• 修复 chapters 子组件 reload() 方法的BUG导致的 outline.reload() 失败的问题 (b3b4626)

3.30.2 (2023-12-05)

Bug Fixes

• 修复缺陷 - issues(#36) - 阅读模式显示正文内容不全 (595b12f)

3.30.1 (2023-10-13)

Bug Fixes

• 修复 issuse #35，scrollElement 参数设置为 DOM 节点报错问题； (5836750)

3.30.0 (2023-09-23)

Features

• 添加 hasToolbar 配置，可以隐藏按钮工具栏；添加 Anchors 模块的独立调用实例； (b5ec0d4)

3.29.0 (2023-09-15)

Features

• 调整 toolbar 工具栏按钮默认颜色；添加新参数 animationCurrent，用于设置当前章节文字的高亮样式；针对超长文章页（1000个有效标题），sticky 和 fixed 布局的菜单直接隐藏，不再使用动画（避免动画卡顿的，优化性能）； (ab9f202)

3.28.0 (2023-09-14)

Features

• 修复在文章中显示 chapters 导航，收起时没有动画的问题；采用延迟绘制合克隆节点的方式，优化 print 界面绘制的性能； (1fad980)

3.27.0 (2023-09-08)

Features

• 配置 print 参数后，针对支持 print() 方法的浏览器，工具栏新增打印按钮，支持直接打印文章 (d36c7e6)

3.26.0 (2023-09-08)

Features

• 调整 print 参数，添加 enterReadingTip 参数，用于设置进入阅读模式的提示文本（暂时还没有精力直接判断浏览器语言，翻译提示信息） (87a96ba)

3.25.1 (2023-09-08)

Bug Fixes

• 修复 package.json 中 files 配置缺少 message.css 和 message.js 导致引入 outline.js 模块的编译错误 (93630b5)

3.25.0 (2023-09-07)

Features

• 优化体验，进入阅读模式添加提示信息 (bb421c0)

3.24.2 (2023-09-06)

Bug Fixes

• 修复 utils 中 cloneDeep() 方法复制数据的逻辑错误 (33ac030)

3.24.1 (2023-09-06)

Bug Fixes

• 修复针对超长文章使用 timeSlice 机制异步绘制 anchors 链接后，针对标题的和导航菜单的 IntersectionObserver 同步高亮当前（异步绘制的）标题无效的问题； (e3a468f)

3.24.0 (2023-09-04)

Features

• 优化 anchors.js 中创建图标链接的性能； (b23312c)
• 针对超长文章，采用 time slice 机制优化性能； (19d5ee8)

3.23.4 (2023-09-01)

Bug Fixes

• 修复 relative 定位时，独立导航菜单关闭窗口图标未显示的问题； (9f874b3)

3.23.3 (2023-09-01)

Bug Fixes

• 去掉 package.json 中的 files 配置 (826c70e)

3.23.1 (2023-09-01)

Bug Fixes

• 调整阅读模式在移动设备的显示效果 (8c237c7)

3.23.0 (2023-08-31)

Features

• 调整打印样式中文章标题的下边距 (6691f8d)
• 调整所有 DOM 元素的绘制逻辑，调用 createElement() 方法中的插入单个子元素，直接用 DOM 元素，较少数组循环的多余调用成本；
• 调整 print() 方法，将更新邻居节点逻辑提取为独立的私有方法； (4a96ecf)

3.22.1 (2023-08-29)

Bug Fixes

• 修复 sticky 定位，窗口调整大小，chapters 导航栏高度没有自适应窗口大小变化的问题 (4694b3c)

3.22.0 (2023-08-29)

Features

• 调整打印样式中文章标题的下边距；
• 调整代码结构，重新打包文件 (556e186)

3.21.0 (2023-08-29)

Features

• 添加 $emit()、$on()、$off() 方法；
• 添加 created、mounted、enterReading、exitReading、beforeDestroy 和 destroyed 事件； (88b087d)

3.20.1 (2023-08-28)

Bug Fixes

• 修复针对 Wordpress 文章页进入阅读模式时，顶部导航栏仍然显示的问题； (11f310b)

3.20.0 (2023-08-26)

Features

• 针对移动设备在阅读模式添加推出阅读模式按钮 (60d3b02)

3.19.1 (2023-08-25)

Bug Fixes

• 修复同一个页面多次实例化 Outline 对象可能出现的属性配置不正确问题； (582a66f)

3.19.0 (2023-08-24)

Features

• 功能扩展，（在配置打印样式后）有纯净的阅读视图（按ESC键可退出）； (966c113)

3.18.1 (2023-08-23)

Bug Fixes

• 修复 icons 工具方法集中的 createElement() 方法中的一次设置多个样式的问题； (182329d)

3.18.0 (2023-08-18)

Features

• 优化 _getChaptersWithCode() 方法中的生成章节索引 code 的算法，性能大幅提升； (22f151f)

3.17.1 (2023-08-16)

Bug Fixes

• 修复配置参数 print.title 为文章标题 DOM 元素，会将正文的标题移动到打印克隆 DOM 元素中的问题 (a70c1c3)

3.17.0 (2023-08-15)

Features

• 添加 chapterTextFilter 参数，用于处理 chapters 菜单中显示的文本； (7d57fb1)

3.16.0 (2023-08-15)

Features

• 调整 title 配置参数的可选值，增加设置“”或者false，不显示导航菜单的标题栏；调整 toolbar 工具栏内置按钮的显示顺序； (a143ed9)

3.15.0 (2023-08-15)

Features

• 优化 print 配置细节，title 可以是 DOM 元素，使标题可以自动变化，更加灵活； (0798bfc)

3.14.0 (2023-08-14)

Features

• 添加 print 配置，支持 print 基础打印样式 (2e43a50)

3.13.2 (2023-08-14)

Bug Fixes

• 修复初始化 scrollElement.scrollTop = 0 时，向上按钮未隐藏的问题 (f36fcb1)

3.13.1 (2023-08-11)

Bug Fixes

• 修复 # 图标没有显示的问题；调整了 chapters 绘制的 DOM 的逻辑； (bfe92ca)

3.13.0 (2023-08-11)

Features

• 添加 tools 配置添加自定义按钮配置；添加 addButton() 和 removeButton() 两个方法，用来在工具栏添加按钮或者移除工具栏按钮 (d63fd62)

3.12.3 (2023-08-10)

Bug Fixes

• 修复页面没有 h1~h6 标签，上下滚动按钮点击报错的问题； (e9c78d6)

3.12.2 (2023-08-10)

Bug Fixes

• 不准备支持 typescript 了 (85d6333)

3.12.0 (2023-08-10)

Features

• 调整 _getChaptersWithCode() 方法，优化算法 (7c3fbd1)

3.11.0 (2023-08-09)

Features

• 添加 git, tags 和 issues 配置参数 (ed3ddf5)

3.10.3 (2023-08-08)

Bug Fixes

• chore: 调整 chapters 组件的高亮选中项 placeholder 定位逻辑，采用 transform 替换 top: calc() 模式定位，修复 customClass 调整样式可能带来的定位不准问题

3.10.2 (2023-08-07)

Bug Fixes

• 调整 _getChaptersWithCode() 方法，移除多余的 index 计算逻辑；添加 VUE 使用 outline.js 的示例； (6f88985)

3.10.1 (2023-08-07)

Bug Fixes

• 修复 Outline 模块，reload()后导航菜单不显示子菜单和点击菜单会报错的问题 (21c8ed3)

3.10.0 (2023-08-05)

Features

• 添加 afterScroll 配置参数，在滚动结束后触发的回调函数 (db5a2d9)

3.9.0 (2023-08-05)

Features

• 调整 scrollTo() 方法的滚动动画处理方式，用 requestAnimationFrame() 替换原本的 setTimeout() (a235c3b)

3.8.1 (2023-08-03)

Bug Fixes

• 修复添加 afterToggle 配置后，调整组件初始化变更导致的 posiiton: relative 菜单显示逻辑错误问题 (5f8483b)

3.8.0 (2023-08-02)

Features

• 优化_getChaptersWithCode() 方法中生成文章章节 code 的算法，调整 groupBy() 方法，直接生成章节 code，移除 _getChaptersWithCode() 中多余的逻辑。理论上性能提升1倍 (91fbdff)

3.7.0 (2023-08-01)

Features

• 重构了 _getChapterParentIdByDiffer() 方法，采用更加简洁的编码方式；添加了 afeterSticky 和 afterToggle 两个新的配置参数，并更新的 API 文档；在 fixed.html 示例中展示了新添加的参数的样式用例 (0d6598f)

3.6.0 (2023-07-31)

Features

• 优化 showCode = false 时的生成 chapters 数据的信息逻辑 (26dd10d)

3.5.4 (2023-07-27)

Bug Fixes

• 修复独立侧滑菜单选中状态样式问题，不是 100% 菜单宽度；调整独立侧滑菜单默认高度，调整为height: auto; 最大高度：calc(100% - 4em) (25dc187)

3.5.3 (2023-07-25)

Bug Fixes

• 修复 Outline 模块中， toTop() 方法高亮第一个导航标题的 count() 判断错误，并移除 toTop() 和 toBottom() 方法中多余的 afterScroll 执行逻辑； (6e34d3a)

3.5.2 (2023-07-25)

Bug Fixes

• 修复侧边栏 toggle() 动画过度被 fixed 或者 sticky 定位的导航菜单遮挡的问题；添加新的示例页面； (d995130)

3.5.1 (2023-07-25)

Bug Fixes

• 修复动态生成 anchor 图标链接点击滚动定位，对于页面有 sticky 定位元素，定位不准的问题，给 chapters 模块也添加 stickyHeight 参数；修复对于 fixed 定位，导航菜单模拟 sticky 定位后，导航菜单宽度变化挡住文章内容的问题； (094f45d)

3.5.0 (2023-07-24)

Features

• UI 细节优化，针对 parentElement 在 CSS 中设置了具体 width 值，outline.toggle() 添加动画过度；并更新 examples 相关页面 (04079bb)

3.4.0 (2023-07-24)

Features

• 添加 stickyHeight 配置参数，用以优化页面有其它（模拟） sticky 定位的 DOM 元素的滚动定位计算 (9af8044)

3.3.6 (2023-07-24)

Bug Fixes

• 修复 fixed 定位，初始化界面就有滚动时的定位问题 (19c5b8b)

3.3.5 (2023-07-23)

Bug Fixes

• 添加 zIndex() 方法，处理目录菜单被页面其他 fixed 或者 sticky 定位的 DOM 元素覆盖 (27ca25a)

3.3.4 (2023-07-22)

Bug Fixes

• 修复 sticky 定位时，在文章段落多，导航菜单高度超过 viewport 高度时无法显示的问题；优化 fixed 定位的 UI 细节；调整 drawer 的 title UI 细节 (5bfbac3)

3.3.3 (2023-07-21)

Bug Fixes

• 修复 relative 定位，标题文字超长换行导致高亮当前标题定位不准问题；修复获取标题offsetTop值不准确的问题 (1064308)

3.3.2 (2023-07-21)

Bug Fixes

• 修复针对 webkit 内核浏览器的滚动条优化样式缺失 (a33a486)

3.3.1 (2023-07-21)

Bug Fixes

• 修复 sticky 和 fixed 定位，菜单按钮控制逻辑问题（应该隐藏页面中的目录导航） (e5852c1)

3.3.0 (2023-07-21)

Features

• 调整 getChapters() 方法，可以获取树结构的数据；添加 homepage 配置参数；调整 Toolbar 按钮样式； (b6193de)

3.2.0 (2023-07-20)

Features

• 添加 count() 方法；调整 createElement() 方法；调整 outline 的 scrollTo() 方法，不再依赖 anchors 实例 (57964d0)
• 优化创建 DOM 界面的性能，使用 DocumentFragment，优化 createElement() 方法 (da76ccc)

3.1.0 (2023-07-19)

Features

• 添加文章没有 h1~h6 标签的处理逻辑；
• 添加缺失的 customClass 样式设置；
• 修复滚动到底部的距离为浮点数值时，向下按钮没有隐藏问题； (b5fba4f)

3.0.0 (2023-07-19)

Features

• 完全重构，发布 3.0.0 版本 (9856338)
• 生成独立模块：anchors.min.js、navigator.min.js、drawer.min.js 和 toolbar.min.js (47ab76b)