Collection Helpers API reference for Collection Helpers in Semantic UI's reactivity system database Guide

Collection Helpers

Collection Helpers are methods available on Signal instances that contain arrays of objects. These helpers provide convenient ways to manipulate and update specific objects within the collection based on their unique id.

Element IDs

Unique ids for each row are the first set value in the following list

  • _id
  • id
  • hash
  • key

If none are set then the record will be ignored

setProperty

Sets a property on an object in the collection that matches the given id.

Syntax

signal.setProperty(id, property, value)

Parameters

NameTypeDescription
idanyThe id of the object to modify
propertystringThe name of the property to set
valueanyThe value to set for the property

Usage

import { Signal } from '@semantic-ui/reactivity';


const users = new Signal([
  { id: 'user1', name: 'Alice', age: 30 },
  { id: 'user2', name: 'Bob', age: 25 }
]);


users.setProperty('user2', 'age', 26);
console.log(users.get());
// Output: [{ id: 1, name: 'Alice', age: 30 }, { id: 2, name: 'Bob', age: 26 }]

replaceItem

Replaces an entire object in the collection that matches the given id.

Syntax

signal.replaceItem(id, newItem)

Parameters

NameTypeDescription
idanyThe id of the object to replace
newItemObjectThe new object to replace the old one

Usage

import { Signal } from '@semantic-ui/reactivity';


const tasks = new Signal([
  { id: 1, task: 'Buy groceries', completed: false },
  { id: 2, task: 'Walk the dog', completed: true }
]);


tasks.replaceItem(1, { id: 1, task: 'Buy groceries', completed: true });
console.log(tasks.get());
// Output: [{ id: 1, task: 'Buy groceries', completed: true }, { id: 2, task: 'Walk the dog', completed: true }]

removeItem

Removes an object from the collection that matches the given id.

Syntax

signal.removeItem(id)

Parameters

NameTypeDescription
idanyThe id of the object to remove

Usage

import { Signal } from '@semantic-ui/reactivity';


const books = new Signal([
  { id: 1, title: 'The Great Gatsby' },
  { id: 2, title: 'To Kill a Mockingbird' }
]);


books.removeItem(1);
console.log(books.get());
// Output: [{ id: 2, title: 'To Kill a Mockingbird' }]

getIndex

Returns the index of an object in the collection that matches the given id.

Syntax

signal.getIndex(id)

Parameters

NameTypeDescription
idanyThe id of the object to find

Returns

number - The index of the object, or -1 if not found.

Usage

import { Signal } from '@semantic-ui/reactivity';


const fruits = new Signal([
  { id: 'a', name: 'apple' },
  { id: 'b', name: 'banana' },
  { id: 'c', name: 'cherry' }
]);


const index = fruits.getIndex('b');
console.log(index); // Output: 1

getID

Returns the id of an object at a specific index in the collection.

Syntax

signal.getID(index)

Parameters

NameTypeDescription
indexnumberThe index of the object

Returns

any - The id of the object at the specified index, or undefined if the index is out of bounds.

Usage

import { Signal } from '@semantic-ui/reactivity';


const animals = new Signal([
  { id: 'dog1', species: 'dog' },
  { id: 'cat1', species: 'cat' },
  { id: 'fish1', species: 'fish' }
]);


const id = animals.getID(1);
console.log(id); // Output: 'cat1'

hasID

Checks if an object at a specific index in the collection has an id.

Syntax

signal.hasID(index)

Parameters

NameTypeDescription
indexnumberThe index of the object to check

Returns

boolean - True if the object at the specified index has an id, false otherwise.

Usage

import { Signal } from '@semantic-ui/reactivity';


const mixed = new Signal([
  { id: 1, value: 'has id' },
  { value: 'no id' },
  { id: 2, value: 'has id too' }
]);


console.log(mixed.hasID(0)); // Output: true
console.log(mixed.hasID(1)); // Output: false