Retrieves the component’s styleId. The styleId represents a set of style parameters we’ve stored for a specific component – colors, fonts, numbers, and booleans.
SDK Version: SDK 1.65.0+
Editor Version: New Editor
Display: Live Site, Preview
Components: Widget, Pinned (aka Fixed-Position) Widget, Page
Once you know the component’s styleId, you can retrieve these style parameters using getStyleParamsByStyleId.
Syntax:
Parameters:
| Name | Type | Description |
|---|---|---|
| callback (required) | Function | A callback function that receives the styleId |
Example:
Retrieves the style parameters of the current component: booleans, numbers, colors, and fonts.
SDK Version: SDK 1.26.0+
Editor Version: New Editor, Old Editor
Display: Live Site, Preview
Components: Widget, Pinned (aka Fixed-Position) Widget, Page
Note:
If calling this method in the settings endpoint, it returns the style parameters of the component that opened the settings endpoint.
Syntax:
Parameters:
| Name | Type | Description |
|---|---|---|
| callback | Function | Callback function to retrieve the style values |
Example:
Returns:
Retrieves the style parameters for a given styleId. The styleId represents a set of style parameters we’ve stored for a specific component – colors, fonts, numbers, and booleans.
SDK Version: SDK 1.65.0+
Editor Version: New Editor
Display: Live Site, Preview
Components: Widget, Pinned (aka Fixed-Position) Widget, Page
You can get the component’s styleId using getStyleId.
Syntax:
Parameters:
| Name | Type | Description |
|---|---|---|
| styleId (required) | String | The component’s styleId |
| onSuccess (required) | Function | Callback function to retrieve the component’s style parameters |
| onFailure | Function | Callback function to handle the case that the styleId wasn't found |
Example: