Definition of Each tags in Exported Custom widgets

Developer
1

Hi There,

I recently exported one custom widgets and i have some queries related to exported custom widgets.

Example :-
{
“version”: 1,
“customWidget”: {
“_id”: “EsBySx3bkFxispXqy”,
“javascript”: “$Some Code$”,
“html”: “”,
“css”: “”,
“name”: “$Name of custom widget$”,
“description”: “”,
“props”: [
{
“id”: “FWAc5XC7iwPFdJkDK”,
“name”: “My Prop”,
“description”: “”,
“requireWriteable”: false,
“type”: “string”
},
{
“id”: “Dah6xWyG6WgC4PeYX”,
“name”: “Widget Start”,
“description”: “”,
“requireWriteable”: false,
“type”: “boolean”
}
],
“events”: [
{
“id”: “yRAS5eBwuHCnNom3y”,
“name”: “My Event”,
“description”: “”,
“type”: {“$Tyep of output from event$”}
}
],
“icon”: “extension”,
“defaultWidth”: 500,
“defaultHeight”: 500,
“thirdPartyLibraries”: ,
“persistentId”: “HY6CpLyvzjzjmT3PE”,
“createdAt”: 1729081684946,
“createdBy”: “GYkJa2ZxiejRpJ8iK”,
“updatedAt”: 1729167175381,
“updatedBy”: “GYkJa2ZxiejRpJ8iK”
}
}

  1. Can anyone explain about each tags in this code (especially persistant id, icon etc) in this custom widget code.
  2. Can i create a custom widget in the similar format outside (Not in Tulip instance) and directly import in custom widget section of Tulip. If yes , How?
2

Hi @sagar007,

I can walk through the tags a bit - I’m curious to understand what you’d like to do with custom widgets/how this information could be helpful.

Are you looking to create custom widgets (CWs) in another dev environment (like VSCode) and then test out in Tulip?

Tags help identify who/what made the CW and created by/updated. The others are related to parts of custom widget creation (HTML, CSS, Javascript), as well as the props and events that they receive, when they were made, and who made them.

It’s not a public API and could change so a little hesitant to put out an exact rationale here since it can change.

Like I said earlier, really curious to understand what you’d like to accomplish :slight_smile:

Sincerely,

Jake