Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
BipanKishore committed May 8, 2024
2 parents 78fed8d + a91d8ed commit 26cebd3
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
This library is highly customizable and can be used in
various applications where flexible layout management is required.

[![resizable-panes-react](https://github.com/BipanKishore/resizable-panes-react/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/BipanKishore/resizable-panes-react/actions/workflows/build.yml) [![Cypress Tests](https://github.com/BipanKishore/resizable-panes-react/actions/workflows/cypress.yml/badge.svg?branch=master)](https://cloud.cypress.io/projects/2xc7po/branches/master/overview) ![nycrc config on GitHub](https://img.shields.io/nycrc/BipanKishore/resizable-panes-react)
[![resizable-panes-react](https://github.com/BipanKishore/resizable-panes-react/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/BipanKishore/resizable-panes-react/actions/workflows/build.yml) ![nycrc config on GitHub](https://img.shields.io/nycrc/BipanKishore/resizable-panes-react)
[![NPM Version](https://img.shields.io/npm/v/resizable-panes-react)](https://www.npmjs.com/package/resizable-panes-react) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/resizable-panes-react)](https://www.npmjs.com/package/resizable-panes-react) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=BipanKishore_resizable-panes-react&branch=master&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=BipanKishore_resizable-panes-react)

<!---
[![Cypress Tests](https://github.com/BipanKishore/resizable-panes-react/actions/workflows/cypress.yml/badge.svg?branch=master)](https://cloud.cypress.io/projects/2xc7po/branches/master/overview)
-->


[Cypress Recoreded tests are available here](https://cloud.cypress.io/projects/2xc7po/branches/master/overview)

## [Quick Demo](https://bipankishore.github.io/resizable-panes/)
Expand Down Expand Up @@ -68,17 +73,15 @@ function App() {

<img height="24px" alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/BipanKishore">

## 👋 Hi there! If you find this project useful or valuable, please consider [Sponsoring Its Development]() or [Buy Me a Coffee]()
## 👋 Hi there! If you find this project useful or valuable do give it star on GitHub or please consider [Sponsoring Its Development]() or [Buy Me a Coffee]()

🚀 By sponsoring, you'll:

**Receive Recognition**:
Sponsors will be prominently displayed on the project's README and other relevant documentation([Doc website](https://bipankishore.github.io/resizable-panes-demo/)).
Sponsors will be prominently displayed on the project's README and other relevant documentation.

**Influence Roadmap**: Your feedback and suggestions will carry significant weight in shaping the project's future direction and features.

🙏 If You liked this project do give it a star

## ResizablePanes Props

| Prop | Type | Default | Required | Description |
Expand Down Expand Up @@ -127,7 +130,7 @@ Sponsors will be prominently displayed on the project's README and other relevan
| Method | Params | Description |
| --------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| restore | | It restores the default view of layout. |
| setSize | (paneId: string, size: number, behaviour: ISetSizeBehaviour) | It excepts the positive number. It sets the size of Pane depending upon: <br /> 1. Its min and max. <br />2. min and max of other panes. <br/> type ISetSizeBehaviour = 'ratio' / 'buttomFirst' / 'topFirst'|
| setSize | (paneId: string, size: number, <br /> behaviour: ISetSizeBehaviour) | It excepts the positive number. It sets the size of Pane depending upon: <br /> 1. Its min and max. <br />2. min and max of other panes. <br/> type ISetSizeBehaviour = 'ratio' / 'buttomFirst' / 'topFirst'|
| setVisibilities | Object | It sets the visibility of Panes using the Boolean map of id of Panes. |
| getSizes | | It returns the size map object of Ids of Panes |
| getVisibilities | | It returns the visibility map object of Ids of Panes |
Expand Down

0 comments on commit 26cebd3

Please sign in to comment.