Update and sync item properties
Update an item's properties, and then sync the item to propagate the changes to the board.
Developer tools in this how-to refer to Chrome DevTools.
Developer tools for other browsers work in a very similar way.
Goal
Update the properties of a board item, and then run sync
on the updated item, so that the changes become effective on the board.
Prerequisites
Before you begin, make sure that:
- Your Miro user account has a Developer team.
Sync after updating
You want to be able to change and update the properties of an existing board item.
In the Miro Web SDK, updating a board item is a 2-step process:
- Edit the values of the properties that you want to change.
- Use the
sync
method to propagate the changes to the board, and to make them visible on the board.
If you assign new values to an item property, and then don't run sync
, the new values are stored locally; they aren't available on the board.
Every time you modify item properties, you need to run sync
on the modified item, so that the changes are reflected on the board.
The following examples show how sync
works.
Example: create, update, and sync a shape item
In this example, you:
- Create a shape item.
- Update the shape properties.
sync
the shape to propagate the changes to the board.
Example: create, update, and sync a frame item
In this example, you:
- Create a frame item.
- Add to the frame the previously created shape as a child item.
- Update the frame properties.
sync
the frame to propagate the changes to the board.remove
the child item from the frame.- Update the frame properties.
sync
the frame to propagate the changes to the board.
Create the frame and add the shape as a child item
Remove the child shape and reposition the frame on the board
Example: create, update, and sync a tag
In this example, you:
- Create a tag.
- Create a card.
- Add the tag to the card.
- Update the tag properties.
sync
the tag to propagate the changes to the board.- Remove the tag from the card, and update the card properties.
sync
the card to propagate the changes to the board.
See also
Updated 11 months ago
Add an app icon to your app so that board users can discover your app on the app toolbar.