Skip to content

Update README and README_CN to document supported features and helper APIs#1

Open
wnagchi wants to merge 1 commit into
masterfrom
codex/update-readme-with-supported-features
Open

Update README and README_CN to document supported features and helper APIs#1
wnagchi wants to merge 1 commit into
masterfrom
codex/update-readme-with-supported-features

Conversation

@wnagchi

@wnagchi wnagchi commented Jan 30, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Clarify and document the framework's current capabilities by matching README content to the actual source implementation.
  • Provide concrete usage examples for router guards, page-level route interception, helper APIs and the canvas wrapper to help developers integrate the library correctly.

Description

  • Updated readme.md and readme_CN.md to reflect supported features and to add usage examples for $toPath route guards ($toPathBefore / $toPathBeforeAsync) and page-level $beforeRouter interception.
  • Reworked and replaced outdated sections with current source-level helper APIs such as $setTimeFn, $animateStart, $call, $backPage, $getHeight, $getNode, $getWxImg, isIphoneX / getNav, WXML helpers ($onTab, $selectItem) and utility helpers ($random, $cutArray, $dataToString, $shinglier, $strSm).
  • Documented canvas usage by adding an example for AniCanvas and clarified that $setStore / $getStore are available on Page/Component instances in addition to the constructor API.
  • Cleaned up English and Chinese READMEs to remove stale store-min build instructions and to align examples with the current source modules.

Testing

  • No automated tests were executed because this change is documentation-only and does not modify runtime code.

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant