Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/builtnorth/wp-component-library
Library of components for use in the WordPress block editor.
https://github.com/builtnorth/wp-component-library
block-library npm-package wordpress wp-components
Last synced: 3 days ago
JSON representation
Library of components for use in the WordPress block editor.
- Host: GitHub
- URL: https://github.com/builtnorth/wp-component-library
- Owner: builtnorth
- Created: 2024-09-06T21:44:18.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T14:27:15.000Z (28 days ago)
- Last Synced: 2024-10-23T17:12:03.523Z (28 days ago)
- Topics: block-library, npm-package, wordpress, wp-components
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@builtnorth/wp-component-library
- Size: 205 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WP Component Library
Library of reusable components for easier WordPress block development. It includes tools for common tasks like media uploads, color settings, and layouts.
## Installation
```bash
npm install @builtnorth/wp-component-library
```
## Components
- [MediaUpload](#mediaupload)
- [SectionSettings](#sectionsettings)
- [AttachmentImage](#attachmentimage)
- [Pagination](#pagination)
### MediaUpload
A set of components for handling media uploads in different contexts.
**Components:**
- `ToolbarMediaUpload`: For use in block toolbars
- `EditorMediaUpload`: A customizable media upload button
- `InspectorMediaUpload`: For use in inspector controls
**Usage:**
```jsx
import { ToolbarMediaUpload, EditorMediaUpload, InspectorMediaUpload } from "@builtnorth/wp-component-library";
// Basic usage
```
### SectionSettings
Components for managing section-level settings.
**Components:**
- `SectionSettings`: General section settings
- `SectionBackground`: Background settings for sections
**Usage:**
```jsx
import { SectionSettings, SectionBackground } from "@builtnorth/wp-component-library";
// Basic usage
```
### AttachmentImage
JS companion to `wp_get_attachment()`. (From [Brian Coords](https://github.com/bacoords/example-image-block/blob/main/src/AttachmentImage.js))
**Usage:**
```jsx
import { AttachmentImage } from "@builtnorth/wp-component-library";
// Basic usage
;
```
### Pagination
A component for displaying pagination.
**Usage:**
```jsx
import { Pagination } from "@builtnorth/wp-component-library";
// Basic usage
;
```
## Disclaimer
This component library is provided "as is" without warranty of any kind, express or implied. Use at your own risk. The authors and contributors are not responsible for any damages or liabilities arising from the use of this library. Always test components thoroughly in your specific environment before deploying to production.