@bigbinary/neeto-payments-frontend 1.0.8 → 1.0.10

package/README.md

@@ -7,9 +7,7 @@ neetoPayments is the library that manages payments across neeto products.
 
 ## Installation
 
-1.  **neetoPayments** has a few peer dependencies that are required for the
-    proper functioning of the package. Install all the peer dependencies using
-    the below command:
+1.  **neetoPayments** has a few peer dependencies that are required for the proper functioning of the package. Install all the peer dependencies using the below command:
 
     ```zsh
     yarn add @bigbinary/neeto-commons-frontend@2.0.54 @bigbinary/neeto-filters-frontend@2.8.1 @bigbinary/neeto-icons@1.9.22 @bigbinary/neeto-molecules@1.0.9 @bigbinary/neetoui@4.4.10 @honeybadger-io/js@5.1.1 @honeybadger-io/react@5.1.3 axios@1.3.4 classnames@2.3.2 formik@2.2.9 js-logger@1.6.1 mixpanel-browser@2.45.0 ramda@0.28.0 react-helmet@6.1.0 react-query@3.39.3 react-router-dom@5.3.4 react-toastify@8.2.0 yup@1.0.2
@@ -33,22 +31,15 @@ neeto-payments-frontend exports:
 
 #### Props
 
-1. **holdableId**: To specify the ID of the entity that holds the stripe
-   account. This is an optional prop. If the value is not specified, the current
-   organization ID is taken as the default value while querying for
-   transactions.
+1. **holdableId**: To specify the ID of the entity that holds the stripe account. This is an optional prop. If the value is not specified, the current organization ID is taken as the default value while querying for transactions.
 
-2. **payableEntityColumns**: To specify the columns from the payable entity
-   which need to be additionally displayed. It is an optional prop that defaults
-   to `[]` if not specified.
+2. **payableEntityColumns**: To specify the columns from the payable entity which need to be additionally displayed. It is an optional prop that defaults to `[]` if not specified.
 
 3. **searchProps**: To specify the properties of the search bar in `Dashboard`.
 
-4. **shouldFetchFilterOptions**: To specify whether or not to fetch the options
-   for columns with filter type as `single_option` or `multi_option`. Its value
-   is `false` by default.
+4. **tabs**: To specify the tabs to be displayed in the payments dashboard. It is an optional parameter.
 
-5. **tabs**: To specify the tabs to be displayed in the payments dashboard. It is an optional parameter.
+5. **headerProps**: To specify the props to be passed to the neetoUI `Header` component used in the `Dashboard`.
 
 **More about `payableEntityColumns`**
 
@@ -90,23 +81,15 @@ const payableEntityColumns = [
 ];
 ```
 
-The `payableEntityColumns` is similar to `columnData` prop used in `Table`
-component in **NeetoUI**. The prop can be modified accordingly to customize the
-columns in the table. For more customizations, refer
+The `payableEntityColumns` is similar to `columnData` prop used in `Table` component in **NeetoUI**. The prop can be modified accordingly to customize the columns in the table. For more customizations, refer
 [NeetoUI docs](https://neeto-ui.neeto.com/?path=/docs/components-table--default).
 
-The additional keys are `isFilterable` and `filterProps`. `filterProps` is used
-to build the list of columns to be represented in the filters pane. The
-`isFilterable` key must be `true` for `filterProps` to be considered.
+The additional keys are `isFilterable` and `filterProps`. `filterProps` is used to build the list of columns to be represented in the filters pane. The `isFilterable` key must be `true` for `filterProps` to be considered.
 
 > :memo: **Note:** The data about the payable entity is in the format
-> `{ payable: {...} }`. So the `dataIndex` key must be used accordingly. Refer
-> the example above.
+> `{ payable: {...} }`. So the `dataIndex` key must be used accordingly. Refer the example above.
 
-> In the case of columns with filter type as `single_option` or `multi_option`,
-> `values` key can be passed along with `filterProps`. Alternatively it be
-> automated using `Dashboard` component. To know more on this, refer "More about
-> shouldFetchFilterOptions prop" section below.
+> In the case of columns with filter type as `single_option` or `multi_option`, `values` key can be passed along with `filterProps`.
 
 **More about `searchProps` prop**
 
@@ -121,28 +104,11 @@ const searchProps = {
 };
 ```
 
-This is passed to the `FiltersBar` and `FiltersPane` components from
-`neeto-filters-frontend`. This is similar to the `keyword` prop used in
-`neeto-filters-frontend` with an additional `placeholder` key which is used as
-the placeholder in the search bar.
+This is passed to the `FiltersBar` and `FiltersPane` components from `neeto-filters-frontend`. This is similar to the `keyword` prop used in `neeto-filters-frontend` with an additional `placeholder` key which is used as the placeholder in the search bar.
 
 To know more about the working of `node` and `model` keys, refer the
 [`neeto-filters-frontend` documentation](https://github.com/bigbinary/neeto-filters-frontend/blob/main/README.md).
 
-**More about `shouldFetchFilterOptions` prop**
-
-`shouldFetchFilterOptions` decides whether or not to fetch the data to be set as
-the `values` key in `filterProp`. For this to work,
-`api/v1/payments/filter_options` endpoint must be defined and it must return the
-filter options.
-
-An example of desired response from the endpoint is:
-
-`{ filterOptions: { host: [...], meeting: [...]}}`
-
-> :memo: **Note:** For the above method to work, the keys inside the
-> `filterOptions` object must match the `key` property in `payableEntityColumns`
-
 **More about `tabs` prop**
 
 `tabs` is an array of strings. It has default value as this: `["all", "successful", "pending", "declined", "refunded"]`.It should only be a subset of the array above. Preferably it shouldn't be an empty array.
@@ -150,14 +116,12 @@ An example of desired response from the endpoint is:
 
 ### 2. `buildStripeTransactionLink` function
 
-This function is used to generate the stripe transaction link from a payment
-identifier.
+This function is used to generate the stripe transaction link from a payment identifier.
 
 The arguments are:
 
 1. `identifier`: The payment identifier
-2. `isLive`: Specifying whether or not the environment is live. It defaults to
-   `true`.
+2. `isLive`: Specifying whether or not the environment is live. It defaults to `true`.
 
 Example usage