Skip to content

Created root README#213

Open
ydaniv wants to merge 8 commits into
masterfrom
interact-root-readme
Open

Created root README#213
ydaniv wants to merge 8 commits into
masterfrom
interact-root-readme

Conversation

@ydaniv
Copy link
Copy Markdown
Collaborator

@ydaniv ydaniv commented May 19, 2026

No description provided.

Copy link
Copy Markdown
Contributor

@ameerf-wix ameerf-wix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. A few inaccuracies concerning the need for 'initial' and some of the types.
I am afraid we must have full-path production links in here and not this relative packages/interact/... as those will work only from within the project

Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
Comment on lines +27 to +29
| [`@wix/interact`](https://www.npmjs.com/package/@wix/interact) | 2.2.2 | Declarative interaction layer (main package) | [README](packages/interact/README.md) · [npm](https://www.npmjs.com/package/@wix/interact) |
| [`@wix/motion`](https://www.npmjs.com/package/@wix/motion) | 2.1.5 | Low-level animation engine | [README](packages/motion/README.md) · [npm](https://www.npmjs.com/package/@wix/motion) |
| [`@wix/motion-presets`](https://www.npmjs.com/package/@wix/motion-presets) | 1.0.2 | Ready-made animation presets | [npm](https://www.npmjs.com/package/@wix/motion-presets) · [preset rules](packages/motion-presets/rules/presets/presets-main.md) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the npm links are duplicated each - necessary?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also you have some links that are not absolute and this will break

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed the URLs.
The duplicate npm links are fine, unless you have a better suggestion for the links to the packages? Would it be better to link to the source on github?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they are duplicated on the same line, yes? you have a table with every row containing the link to the package npm-page twice.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe linking to github makes sense actually

Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
### Rules files

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
**@wix/interact** (also on [GitHub Pages /rules/](https://wix.github.io/interact/rules/integration.md)):
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it makes sense to link to integration.md here in the title, and then again one line below.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
- For `viewProgress`, avoid `overflow: hidden` on ancestors; use `overflow: clip` instead
- Call `generate(config)` at build time or on the server and inject CSS into `<head>`. For `viewEnter` + `triggerType: 'once'`, also set `initial` on the element to prevent FOUC

### Repository agent context
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Repository agent context
### Repository agent context for development

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants