https://github.com/constructor-io/constructorio-ui-plp
Constructor.io Product Listing Pages (PLP) UI library for web applications
https://github.com/constructor-io/constructorio-ui-plp
constructorio-integrations javascript react react-hooks typescript
Last synced: about 2 months ago
JSON representation
Constructor.io Product Listing Pages (PLP) UI library for web applications
- Host: GitHub
- URL: https://github.com/constructor-io/constructorio-ui-plp
- Owner: Constructor-io
- License: mit
- Created: 2023-08-25T16:45:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T01:24:45.000Z (about 2 months ago)
- Last Synced: 2025-04-12T17:22:43.647Z (about 2 months ago)
- Topics: constructorio-integrations, javascript, react, react-hooks, typescript
- Language: TypeScript
- Homepage: https://constructor-io.github.io/constructorio-ui-plp/
- Size: 5.61 MB
- Stars: 3
- Watchers: 8
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Constructor PLP UI Library
[](https://www.npmjs.com/package/@constructor-io/constructorio-ui-plp)
[](https://github.com/Constructor-io/constructorio-ui-plp/blob/main/LICENSE)
## Introduction
A UI library that provides React components to manage the fetching and rendering logic for [Search](https://constructor.io/products/search/) & [Browse](https://constructor.io/products/browse/) product listing pages powered by Constructor. Typescript support is available.
Our [Storybook Docs](https://constructor-io.github.io/constructorio-ui-plp/?path=/docs/general-introduction--documentation) are the best place to explore the behavior and the available configuration options for this UI library.
## Installation
```bash
npm i @constructor-io/constructorio-ui-plp
```
## Usage
### Using the React Component
The `CioPlp` component handles state management, data fetching, and rendering logic for the entire PLP.
```jsx
import CioPlp from '@constructor-io/constructorio-ui-plp';
function YourComponent() {
return (
);
}
```
### Using the JavaScript Bundle
This is a framework agnostic method that can be used in any JavaScript project. The `CioPlp` function provides a simple interface to inject an entire PLP UI into the provided `selector`.
In addition to [PLP component props](https://constructor-io.github.io/constructorio-ui-plp/?path=/docs/plp-component--docs), this function also accepts `selector` and `includeCSS`.
```js
import CioPlp from '@constructor-io/constructorio-ui-plp/constructorio-ui-plp-bundled';
CioPlp({
selector: '#plp-container',
includeCSS: true, // Include the default CSS styles - defaults to true
apiKey: 'key_M57QS8SMPdLdLx4x',
// ... additional arguments
});
```
## Custom Styling
### Library Defaults
By default, importing React components from this library does not pull any CSS into your project.
If you wish to use starter styles from this library, add an import statement similar to the example import statement below:
```js
import '@constructor-io/constructorio-ui-plp/styles.css';
```
- The starter styles can be used as a foundation to build on top of, or as a reference to be replaced completely.
- To opt out of all default styling, simply do not import the `styles.css` stylesheet.
- All starter styles in this library are scoped within the `.cio-plp` CSS selector.
- The starter styles are intended to be extended by layering in your own CSS rules.
- If the starter styles are imported, `CioPlp` component will take up the full width and height of the parent container.
> Please note the starter styles utilize @container queries and enable responsive styles for our PLPs based on the size of their container element. Since this feature is supported by modern browsers, polyfills have not been included in this library. However, if you want to support older browsers, you can add fallback styles or use a [polyfill](https://github.com/GoogleChromeLabs/container-query-polyfill).
## Troubleshooting
### Known Issues
**Older JavaScript environments**
The library provides two different builds: CommonJS (cjs) and ECMAScript Modules (mjs).
For ECMAScript Modules (mjs) build. The JavaScript version is ESNext which might not be supported by your environment.
If that's the case and your environment is using an older JavaScript version like ES6 (ES2015), you may get this error:
`Module parse failed: Unexpected token (15:32)
You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file`
To solve this you can import the CommonJS (cjs) build which supports ES6 (ES2015) syntax:
`import CioPlp from '@constructor-io/constructorio-ui-plp/cjs'`
**ESLint**
There is a known issue with ESLint where it fails to resolve the paths exposed in the `exports` statement of NPM packages. If you are receiving the following error, you can safely disable ESLint using `// eslint-disable-line` for that line.
`Unable to resolve path to module '@constructor-io/constructorio-ui-plp/styles.css'`
Relevant open issues: [Issue 1868](https://github.com/import-js/eslint-plugin-import/issues/1868), [Issue 1810](https://github.com/import-js/eslint-plugin-import/issues/1810)
## Local Development
### Development Scripts
```bash
npm ci # Install dependencies for local dev
npm run dev # Start a local dev server for Storybook
npm run lint # Run lint
```
### Library Maintenance
```bash
npm run compile # Generate lib folder for publishing to npm
npm run build-storybook # Generate Storybook static bundle for deploy with GitHub Pages
```
## Publishing new versions
Dispatch the [Publish](https://github.com/Constructor-io/constructorio-ui-plp/actions/workflows/publish.yml) workflow in GitHub Actions. You're required to provide two arguments:
- **Version Strategy**: `major`, `minor`, or `patch`.
- **Title**: A title for the release.
This workflow will automatically:
1. Bump the library version using the provided strategy.
2. Create a new git tag.
3. Create a new GitHub release.
4. Compile the library.
5. Publish the new version to NPM.
6. Deploy the Storybook docs to GitHub Pages.
7. Report the progress on the [relevant Slack channel](https://constructor.slack.com/archives/C061D3CFVR9).
#### ℹ️ Note: Please don't manually increase the package.json version or create new git tags.
The library version is tracked by releases and git tags. We intentionally keep the package.json version at `0.0.0` to avoid pushing changes to the `main` branch. This solves many security concerns by avoiding the need for branch-protection rule exceptions.
## New Storybook Version
Dispatch the [Deploy Storybook](https://github.com/Constructor-io/constructorio-ui-plp/actions/workflows/deploy-storybook.yml) workflow in GitHub Actions.
#### ℹ️ Note: This is already done automatically when publishing a new version.
## Supporting Docs
- [Storybook 7 Introduction](https://storybook.js.org/docs/7.0/react/get-started/introduction)
- [Typescript Docs](https://www.typescriptlang.org/docs/)