https://github.com/codesyntax/ionic-react-utils

A suite of components and utilities for Ionic Framework with React
https://github.com/codesyntax/ionic-react-utils

ionic ionic-framework react vite

Last synced: 3 months ago
JSON representation

A suite of components and utilities for Ionic Framework with React

• Host: GitHub
• URL: https://github.com/codesyntax/ionic-react-utils
• Owner: codesyntax
• Created: 2024-02-27T15:46:30.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-05-27T15:43:40.000Z (8 months ago)
• Last Synced: 2024-10-02T06:21:42.733Z (4 months ago)
• Topics: ionic, ionic-framework, react, vite
• Language: TypeScript
• Homepage: https://codesyntax.github.io/ionic-react-utils/
• Size: 4.88 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# ionic-react-utils

A suite of components and utilities for Ionic Framework with React.

## Installation

To install the package, use npm or yarn:

```bash

npm install @codesyntax/ionic-react-utils

```

or

```bash

yarn add @codesyntax/ionic-react-utils

```

## Usage

Import the desired component or utility in your React project:

```jsx

import { SomeIonicReactUtility } from '@codesyntax/ionic-react-utils';

function App() {

  return (

    


      

    

  );

}

```


## Available Components and Utilities

- **IonPasswordInput**: IonInput component for passwords with the option to show or hide the text.

- **InnerHTML**: Render any string or URL content in HTML format.

- **useIonHeaderCollapse**: Collapse the header when scrolling the content to get more space on the screen.

- **useIonHeaderParallax**: Get an integrated parallax effect with the IonHeader component.

- **usePinchToZoom**: Zoom in on images using the pinch-to-zoom.

## Contributing

To contribute, fork the repository and create a pull request.

## License

This project is licensed under the MIT License.