WET-BOEW 会话超时组件多语言文本定制方案

背景介绍

WET-BOEW（Web Experience Toolkit）是加拿大政府开发的一套Web标准工具包，其中包含了一个会话超时组件（Session Timeout widget），用于在用户长时间不操作页面时提示会话即将超时。该组件在多语言环境下工作，默认支持英语和法语。

问题发现

在实际使用中发现，英语和法语版本的会话超时提示存在不一致性。法语版本使用"session"（会话）相关术语，而英语版本在某些情况下使用了"sign in"（登录）相关表述。这种差异会导致以下问题：

1. 在不要求用户登录的场景下（如多页表单），"sign in"提示会给用户造成困惑
2. 英语和法语版本术语不统一，影响用户体验一致性
3. 按钮标签与实际情况不符

技术解决方案

为解决这一问题，WET-BOEW团队提出了通过配置参数覆盖默认文本的解决方案。该方案允许开发者根据实际应用场景自定义会话超时组件的显示文本。

配置参数详解

开发者可以通过在HTML元素中添加data-wb-sessto属性来配置会话超时组件，新增的textOverride对象支持覆盖以下文本项：

1. buttonContinue - 继续会话按钮文本
2. buttonEnd - 结束会话按钮文本
3. buttonSignin - 登录/开启新会话按钮文本
4. timeoutBegin - 会话即将超时提示文本
5. timeoutEnd - 会话已超时提示文本
6. timeoutTitle - 超时对话框标题
7. timeoutAlready - 会话已过期提示文本

实现示例

<span class="wb-sessto" 
      data-wb-sessto='{
        "inactivity": 30000, 
        "reactionTime": 30000, 
        "logouturl": "../index-en.html", 
        "textOverride": {
          "buttonSignin": "Open a new session", 
          "timeoutAlready": "Sorry, your session has expired. Please open a new session."
        }
      }'>
</span>

技术优势

1. 灵活性：允许根据不同应用场景定制提示文本
2. 一致性：确保多语言版本术语统一
3. 兼容性：不影响现有功能的正常使用
4. 易用性：通过简单配置即可实现文本覆盖

应用场景

这种文本定制功能特别适用于以下场景：

1. 多页表单：不需要用户登录，但需要保持会话状态的场景
2. 公共服务系统：需要严格保持英法双语一致性的政府网站
3. 定制化应用：有特殊术语要求的企业内部系统

最佳实践建议

1. 在不需要用户登录的场景下，建议统一使用"session"相关术语
2. 保持英法双语版本术语的一致性
3. 根据实际应用场景选择最合适的提示文本
4. 测试不同文本长度对界面布局的影响

通过这种灵活的文本覆盖机制，WET-BOEW的会话超时组件能够更好地适应各种应用场景，提供更一致、更友好的用户体验。