Skip to content

Commit

Permalink
GITBOOK-1: Change structure names
Browse files Browse the repository at this point in the history
  • Loading branch information
JoseLion authored and gitbook-bot committed Aug 3, 2023
1 parent 9ef2528 commit 21e396d
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 23 deletions.
7 changes: 7 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Table of contents

* [Overview](README.md)
* [Packages](packages/README.md)
* [Core](packages/core/README.md)
* [Native](packages/native/README.md)
* [Web](packages/web/README.md)
2 changes: 2 additions & 0 deletions packages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Packages

45 changes: 22 additions & 23 deletions packages/web/README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,41 @@
[![CI](https://github.com/JoseLion/lynxts/actions/workflows/ci.yml/badge.svg)](https://github.com/JoseLion/lynxts/actions/workflows/ci.yml)
[![Release](https://github.com/JoseLion/lynxts/actions/workflows/release.yml/badge.svg)](https://github.com/JoseLion/lynxts/actions/workflows/release.yml)
[![NPM version](https://img.shields.io/npm/v/@lynxts/web?logo=npm)](https://www.npmjs.com/package/@lynxts/web)
[![NPM bundle size](https://img.shields.io/bundlephobia/min/@lynxts/web)](https://www.npmjs.com/package/@lynxts/web)
[![NPM downloads](https://img.shields.io/npm/dm/@lynxts/web)](https://www.npmjs.com/package/@lynxts/web)
[![NPM license](https://img.shields.io/npm/l/@lynxts/web)](./LICENSE)
[![GitHub Release Date](https://img.shields.io/github/release-date/JoseLion/lynxts)](https://github.com/JoseLion/lynxts/releases)
[![Known Vulnerabilities](https://snyk.io/test/github/JoseLion/lynxts/badge.svg)](https://snyk.io/test/github/JoseLion/lynxts)
# Web

<img alt="Lynx.ts Logo" src="https://github.com/JoseLion/lynxts/blob/main/docs/assets/lynxts-logo%40512x512.png?raw=true" width="128">
[![CI](https://github.com/JoseLion/lynxts/actions/workflows/ci.yml/badge.svg)](https://github.com/JoseLion/lynxts/actions/workflows/ci.yml) [![Release](https://github.com/JoseLion/lynxts/actions/workflows/release.yml/badge.svg)](https://github.com/JoseLion/lynxts/actions/workflows/release.yml) [![NPM version](https://img.shields.io/npm/v/@lynxts/web?logo=npm)](https://www.npmjs.com/package/@lynxts/web) [![NPM bundle size](https://img.shields.io/bundlephobia/min/@lynxts/web)](https://www.npmjs.com/package/@lynxts/web) [![NPM downloads](https://img.shields.io/npm/dm/@lynxts/web)](https://www.npmjs.com/package/@lynxts/web) [![NPM license](https://img.shields.io/npm/l/@lynxts/web)](LICENSE/) [![GitHub Release Date](https://img.shields.io/github/release-date/JoseLion/lynxts)](https://github.com/JoseLion/lynxts/releases) [![Known Vulnerabilities](https://snyk.io/test/github/JoseLion/lynxts/badge.svg)](https://snyk.io/test/github/JoseLion/lynxts)

# Lynx.ts Web
![Lynx.ts Logo](../../docs/assets/lynxts-logo%40512x512.png)

## Lynx.ts Web

TypeScript-first, lightning fast Forms for React.js and React Native. The `@lynxts/web` package provides abstractions and helpers specifically for React DOM, which makes working with forms simpler, more maintainable, and intuitive.

## Requirements
### Requirements

- **[lynxts/core](../core/README.md):** Same as the `@lynxts/web` version used
- **[React.js](https://react.dev/):** >=16.8.0
- **[React DOM](https://www.npmjs.com/package/react-dom):** >=16.8.0
- **[Yup](https://github.com/jquense/yup):** >=1.0.0
* [**lynxts/core**](../core/)**:** Same as the `@lynxts/web` version used
* [**React.js**](https://react.dev/)**:** >=16.8.0
* [**React DOM**](https://www.npmjs.com/package/react-dom)**:** >=16.8.0
* [**Yup**](https://github.com/jquense/yup)**:** >=1.0.0

## Install
### Install

Using Yarn:

```
yarn add @lynxts/core @lynxts/web react react-dom yup
```

Using NPM:

```
npm i @lynxts/core @lynxts/web react react-dom yup
```

## Usage
### Usage

To make using forms in React.js web applications as simple as possible, `@lynxts/web` provides a `<Form>` React component, which is nothing more than a

To make using forms in React.js web applications as simple as possible, `@lynxts/web` provides a `<Form>` React component, which is nothing more than a [<form> element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) wrapped around Lynx.ts `<FormProvider>`. This component accepts all the attributes of a `<form>` plus all the `<FormProvider>` props which you can use to set up the context. With this approach, your forms will not only be semantically correct, but you can also use a [<button>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button) or an [<input type="submit">](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/submit) to trigger the submit action.
[element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) wrapped around Lynx.ts `<FormProvider>`. This component accepts all the attributes of a `<form>` plus all the `<FormProvider>` props which you can use to set up the context. With this approach, your forms will not only be semantically correct, but you can also use aor an to trigger the submit action.

Additionally, this package provides helper components of the basic form elements: `<input>`, `<select>`, and `<textarea>`. These components adds a `<label>` and error handling and their intention is for users to quickly jump into using simple forms. However, we strongly recommend creating you own [custom field](../core/README.md#custom-fields) abstractions to get better control and customization.
Additionally, this package provides helper components of the basic form elements: `<input>`, `<select>`, and `<textarea>`. These components adds a `<label>` and error handling and their intention is for users to quickly jump into using simple forms. However, we strongly recommend creating you own [custom field](../core/#custom-fields) abstractions to get better control and customization.

```tsx
import { FormProvider } from "@lynxts/core";
Expand Down Expand Up @@ -74,14 +73,14 @@ const SignIn = memo((): ReactElement => {
});
```

## Something's missing?
### Something's missing?

Suggestions are always welcome! Please create an [issue](https://github.com/JoseLion/lynxts/issues/new) describing the request, feature, or bug. We'll try to look into it as soon as possible 🙂

## Contributions
### Contributions

Contributions are very welcome! To do so, please fork this repository and open a Pull Request to the `main` branch.

## License
### License

[MIT License](./LICENSE)
[MIT License](LICENSE/)

0 comments on commit 21e396d

Please sign in to comment.