Skip to content

1.1.0 #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
May 17, 2024
Merged
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Website
# Trivule documentation

This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
This repository contains the official documentation for Trivule

### Installation

Expand All @@ -21,21 +21,3 @@ This command starts a local development server and opens up a browser window. Mo
```
$ npm build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true npm deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> npm deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
2 changes: 1 addition & 1 deletion docs/events/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Trivule provides the ability to listen for different JavaScript events to trigge

## Triggering Validation with Default Events

By default, Trivule uses the `input`, `blur`, and `change` events to trigger form field validation. This means that whenever a user enters, leaves, or modifies a value in a form field, validation is automatically triggered.
By default, Trivule uses the `blur`, and `change` events to trigger form field validation. This means that whenever a user enters, leaves, or modifies a value in a form field, validation is automatically triggered.

For instance, if you want to trigger validation when an element is hovered over by the mouse cursor, you can use Trivule's `data-tr-events` attribute and specify the `mouseenter` event as follows:

Expand Down
Loading
Loading