@ionic-selectable/core

Ionic Selectable

Demo | Features | Getting started | FAQ | Docs

An Ionic component similar to Ionic Select, that allows to search items, including async search, infinite scrolling and more.

Contents

• Demo
• Features
• Getting started
• Supported Ionic versions
• FAQ
• Docs
• Theming

Supported Ionic versions

• Ionic 5 (>=5.0.0) alpha

Supported previus Ionic versions

• Ionic 3 (3.6.0 - 3.9.2) ionic-selectable
• Ionic 4 (>=4.0.0) ionic-selectable

Features

• Single selection
• Multiple selection
• Search items
• Search items asynchronously
• Search by several item fields
• Forms
• InfiniteScroll
• VirtualScroll
• Templates
• Grouping items
• Editing, adding and deleting items
• Disabling items

Getting started

1. Add add the following inside the .

<!-- Ionic -->
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core/dist/ionic/ionic.esm.js"></script>
<script nomodule src="https://cdn.jsdelivr.net/npm/@ionic/core/dist/ionic/ionic.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core/css/ionic.bundle.css" />
<!-- Ionic Selectable -->
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic-selectable/core/dist/ionic-selectable/ionic-selectable.esm.js"></script>
<script nomodule src="https://cdn.jsdelivr.net/npm/@ionic-selectable/core/dist/ionic-selectable/ionic-selectable.js"></script>

1. Add it to template.

<ion-item>
  <ion-label>Ports</ion-label>
  <ionic-selectable
    id="port"
    should-store-item-value="false"
    is-multiple="false"
    item-value-field="id"
    item-text-field="name"
    placeholder="Select One"
    group-text-field="country.name"
  ></ionic-selectable>
</ion-item>

1. Configure it.

var portElement = document.getElementById("port");
portElement.items = [
  { id: 1, name: "Salina Cruz", country: { name: "Mexico" } },
  { id: 3, name: "Veracruz", country: { name: "Mexico" } },
  { id: 2, name: "Alicante", country: { name: "Spain" } },
  { id: 4, name: "Santa Eugenia De Riveira", country: { name: "Spain" } },
  { id: 5, name: "Mantes", country: { name: "France" } },
];
portElement.value = {
  id: 1,
  name: "Salina Cruz",
  country: { name: "Mexico" },
};
portElement.hasConfirmButton = true;
portElement.value = { id: 1, name: 'Salina Cruz', country: { name: "Mexico"} };
portElement.addEventListener("changed", (event) => {
  console.log(event);
});
portElement.addEventListener("closed", (event) => {
  console.log(event);
});

1. Enjoy it 😉
2. Check out live demos to see what it is capable of.
   Also, explore the docs and FAQ to learn more about its features.

Development

For contribution and delevopment please refer to Contribution.

Share it

If you find this component useful, please star the repo to let others know that it's reliable. Also, share it with friends and colleagues who might find it useful as well. Thank you 😄