gutenberg-post-picker
v0.3.0
Published
A simple Post Picker Component build with the core gutenberg components.
Downloads
20
Maintainers
Readme
PostPicker
A simple Post Picker Component build with the core gutenberg components. This component does not include any build files and does not bundle the WordPress components. Therefore this needs to be used in an environemt where the Dependency Extraction Webpack Plugin
is used and the import { component } from '@wordpress/package';
is supported.
Usage
import { PostPicker } from 'gutenberg-post-picker';
function MyComponent( props ) {
return (
<PostPicker
onPostSelect={ console.log }
label={ "Please select a Post or Page:" }
postTypes={ [ 'posts', 'pages' ] }
/>
)
}
Props
| Name | Type | Default | Description |
| ---------------- | ---------- | --------------------- | ---------------------------------------------------------------------- |
| onPostSelect
| function
| undefined
| Callback function that gets called with the post object upon selection |
| label
| string
| ''
| Renders a label for the Search Field. |
| placeholder
| string
| ''
| Renders placeholder text inside the Search Field. |
| postTypes
| array
| [ 'posts', 'pages' ]
| Names of the post types that should get searched |
The postTypes
will get used like this:
wp.apiFetch( {
path: `/wp/v2/${postType}?search=${searchTerm}`
} )