Note

All code samples below refer to the skuid object.

In the v2 API, this object is not directly accessible when working within a browser console—or when referring to another Skuid page runtime.

If you are experiencing issues, use the skuid.runtime API to target the appropriate page context.

skuid.builder.core.coreProps

A library of functions for generating standard properties that are used by many or most components.


Good news, everyone!

We are currently writing more material for our Javascript API. All of the objects and functions you see below are part of Skuid’s public API, even if they aren’t fully documented yet. Feel free to experiment while we write about them—and check back later for updates.


Functions

skuid.builder.core.coreProps.cssClassProp()

Returns a PropertyListItem for a CSS Class property.

skuid.builder.core.coreProps.uniqueIdProp(parameters)

Returns a PropertyListItem for a Unique ID property. A component’s Unique ID identifies it on the page and enables Skuid to distinguish between two otherwise identical components. The Unique ID typically appears as an id attribute at runtime in the rendered component’s top-level DOM element, but this is not required.

Arguments:
  • parameters

    A required dictionary object with the following properties:

    skuid.builder.core.coreProps.component

    REQUIRED. An instance of skuid.builder.Component.

    onChange(newValue, oldValue)

    Optional. A function to call when the Unique ID property has changed.

    Arguments:
    • newValue – The newly entered value. This will be the Unique ID value in the future.
    • oldValue – The previous value. This was the Unique ID value in the past.