Skip to content

Commit 6651b6e

Browse files
mocca102esezen
andauthored
Add Advanced Features (#208)
* Add Advanced Features * Add code examples section to readme (#209) * Add code examples section to readme * Update README.md Co-authored-by: Enes Kutay SEZEN <[email protected]> * Update README.md Co-authored-by: Enes Kutay SEZEN <[email protected]> --------- Co-authored-by: Enes Kutay SEZEN <[email protected]> --------- Co-authored-by: Enes Kutay SEZEN <[email protected]>
1 parent 12845d9 commit 6651b6e

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@
2828
- ♿ Accessible (a11y) – Built-in ARIA support for screen readers
2929
- 🛡 Written in TypeScript with type safety
3030

31-
## Installation & Quick Start
31+
## Installation & Quick Start
3232
Install the library
33+
3334
```sh
3435
npm i @constructor-io/constructorio-ui-autocomplete
3536
```
3637

3738
Import and use the `CioAutocomplete` component
39+
3840
```ts
3941
import { CioAutocomplete } from '@constructor-io/constructorio-ui-autocomplete';
4042
import '@constructor-io/constructorio-ui-autocomplete/styles.css';
@@ -48,4 +50,22 @@ function YourComponent() {
4850
/>
4951
</div>
5052
);
51-
```
53+
```
54+
55+
## 💡 Code Examples
56+
57+
Ready-to-use, copy-paste examples with explanations.
58+
59+
- [Full Featured example](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component--docs#full-featured-and-styled-example)
60+
- [Render Search Suggestions](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component-sections--docs#render-search-suggestions)
61+
- [Render Product Suggestions](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component-sections--docs#render-suggested-products)
62+
63+
🔹 For more examples check the [full examples](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component--docs)
64+
65+
## 🚀 Advanced Features
66+
67+
- [Terms With Group Suggestions](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component-advanced-parameters--docs#terms-with-group-suggestions)
68+
- [Filtered Suggestions](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component-advanced-parameters--docs#filtered-suggestions)
69+
- [Terms With Images And Counts](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component-advanced-parameters--docs#terms-with-images-and-counts)
70+
71+
🔹 For more advanced use cases check the [full documentation](https://constructor-io.github.io/constructorio-ui-autocomplete/?path=/docs/autocomplete-component-advanced-parameters--docs)

0 commit comments

Comments
 (0)