Skip to content

Commit 2d2d233

Browse files
committed
update readme
1 parent e2a2f6d commit 2d2d233

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ In the above example, CSS variable `--scrolled` will be available to `#greeting`
5151
| `tg-step` | Optional | `0` | Step per increment, if this value is other than `0`, will override `tg-steps`. |
5252
| `tg-map` | Optional | (Empty) | map the value to another value. Format: `value: newValue; value2: newValue2`. Multiple values map to one value is also supported: `value,value2,value3: newValue` |
5353
| `tg-filter` | Optional | (Empty) | Only trigger if the scroll value is on the list. Format: `1,3,5,7,9`. By default, the filter mode is `retain`, if we want to switch the mode to `exact`, add an `!` at the end. Read more about this in a dedicated section below. |
54-
| `tg-edge` | Optional | cover | When should the calculation starts. `cover` means off-screen to off-screen, the calculation begins right on the element appear; `inset` means the calculation begins after the whole element appears on screen, ends right before off-screen. |
54+
| `tg-edge` | Optional | cover | When should the calculation starts and ends. `cover` means off-screen to off-screen, the calculation begins right on the element appear at the bottom, ends after the element disappears at the top; `inset` means the calculation begins after the top edge of the element touches the top of the screen, ends when the bottom edge of the element reached the bottom of the screen. See below section for a diagram. |
5555
| `tg-follow` | Optional | (Empty) | Use the calculation result from another element instead. The value of `tg-follow` is the value of the target element's `tg-ref`. **Important**: When `tg-follow` is set, `tg-from`, `tg-to`, `tg-steps`, `tg-step` and `tg-edge` will be ignored in the same element. |
5656
| `tg-ref` | Optional | (Empty) | Define the name that can be referenced (followed) by another element using `tg-follow`. |
5757

README.zh-Hans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
| `tg-step` | 选填 | `0` | 每次递加的数值,如果此值不为 `0`,则会忽略 `tg-steps` 的设置。 |
5050
| `tg-map` | 选填 | (空白字符串) | 将一个值映射至另一个值。格式:`value: newValue; value2: newValue2`。也支持同时将多个值映射至另一个值:`value,value2,value3: newValue` |
5151
| `tg-filter` | 选填 | (空白字符串) | 仅当滚动值在列表当中时才触发,格式:`1,3,5,7,9`。默认情况下,过滤模式是 `retain`(保留值),在设定值末端加入 `!` 符号可以将模式切换为 `exact`(绝对)。关于两个模式的区别,请参考后续的内容。 |
52-
| `tg-edge` | 选填 | cover | 计算滚动值的起始点`cover` 代表画面外至画面外,即在元素进入画面时即开始计算`inset` 代表在元素完整进入画面时开始计算,在刚离开画面时终止|
52+
| `tg-edge` | 选填 | cover | 计算滚动值的起始点与结束点`cover` 代表画面外至画面外,即在元素从底部进入画面时开始计算,从顶部完整离开画面时结束`inset` 代表当元素的顶部触及页面的顶部时开始计算,元素的底部触及页面的底部时结束。以下将有图解说明|
5353
| `tg-follow` | 选填 | (空白字符串) | 引用其他元素的计算值。`tg-follow` 的设定值等于目标元素的 `tg-ref` 设定值。**注意**:当设定了 `tg-follow`,同一元素下的 `tg-from``tg-to``tg-steps``tg-step` 以及 `tg-edge` 设置会被忽略。 |
5454
| `tg-ref` | 选填 | (空白字符串) | 定义可以被其他元素通过 `tg-follow` 引用的名称。 |
5555

README.zh-Hant.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
| `tg-step` | 選填 | `0` | 每次遞加的數值,如果此值不為 `0`,則會忽略 `tg-steps` 的設定。 |
5050
| `tg-map` | 選填 | (空白字串) | 將一個值映射至另一個值。格式:`value: newValue; value2: newValue2`。亦支援同時將多個值映射至另一個值:`value,value2,value3: newValue` |
5151
| `tg-filter` | 選填 | (空白字串) | 只當捲動值在列表當中時才觸發,格式:`1,3,5,7,9`。預設情況下,過濾模式是 `retain`(保留值),在設定值末端加入 `!` 符號可以將模式切換為 `exact`(絕對)。關於兩個模式的分別,請參考後續的內容。 |
52-
| `tg-edge` | 選填 | cover | 計算捲動值的起始點`cover` 代表畫面外至畫面外,即在元素進入畫面時即開始計算`inset` 代表在元素完整進入畫面時開始計算,在剛離開畫面時終止|
52+
| `tg-edge` | 選填 | cover | 計算捲動值的起始點與結束點`cover` 代表畫面外至畫面外,即在元素從底部進入畫面時開始計算,從頂部完整離開畫面時結束`inset` 代表當元素的頂部觸及頁面的頂部時開始計算,元素的底部觸及頁面的底部時結束。以下將有圖解說明|
5353
| `tg-follow` | 選填 | (空白字串) | 引用其他元素的計算值。`tg-follow` 的設定值等於目標元素的 `tg-ref` 設定值。**注意**:當設定了 `tg-follow`,同一元素下的 `tg-from``tg-to``tg-steps``tg-step` 以及 `tg-edge` 設定會被忽略。 |
5454
| `tg-ref` | 選填 | (空白字串) | 定義可以被其他元素透過 `tg-follow` 引用的名稱。 |
5555

0 commit comments

Comments
 (0)