piral-search - npm Package Compare versions

Comparing version 0.8.0-pre.682 to 0.8.0-pre.683

package.json

 {
   "name": "piral-search",
-  "version": "0.8.0-pre.682",
+  "version": "0.8.0-pre.683",
   "description": "Extensions for centralizing search in Piral.",
@@ -38,3 +38,3 @@ "keywords": [
   "devDependencies": {
-    "piral-core": "^0.8.0-pre.682"
+    "piral-core": "^0.8.0-pre.683"
   },
@@ -44,3 +44,3 @@ "peerDependencies": {
   },
-  "gitHead": "04da0183524adea0bae44c0f30f2b3ee1ce36e88"
+  "gitHead": "2a3db9bdcf5523446ac735eb5f064be6afd600ba"
 }

README.md

@@ -24,5 +24,5 @@ [![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io)
 ```tsx
-renderInstance({
+const instance = createInstance({
   // important part
-  extendApi: extendApis([createSearchApi]),
+  extendApi: [createSearchApi()],
   // ...
@@ -32,4 +32,23 @@ });
 
+Via the options the initially displayed `results` can be defined. The current `query` can also be set.
+
+For example:
+
+```tsx
+const instance = createInstance({
+  // important part
+  extendApi: [createSearchApi({
+    query: '!help',
+    results: [
+      <div>
+        Help was found!
+      </div>,
+    ],
+  })],
+  // ...
+});
+```
+
 ## License
 
 Piral is released using the MIT license. For more information see the [license file](./LICENSE).

No alert changes

Improved metrics

Total package byte prevSize

57166

increased by0.59%

Number of lines in readme file

53

increased by55.88%

No dependency changes