Function createDynamicProperty

createDynamicProperty<Schema extends PropsSchema>(
    namespace: Namespace,
    options: {
        category?: string;
        description?: string;
        icon?: IconRef;
        id?: string;
        name: string;
        propsSchema: Schema;
        valueTypes?: PropertyValueType[];
        writable: boolean;
        useDynamicProperty(
            props: CurrentSchemaValues<Schema>,
        ): UseDynamicPropertyResult;
    },
): CreateDynamicPropertyResult<Schema>
Creates a HELIO Dynamic Property.

Dynamic properties are configurable values that can change dynamically over time and support write operations.

Note: New dynamic properties need to be added to the extension's library (see createLibraryExtension) to become active in HELIO.
Type Parameters
- Schema extends PropsSchema
Parameters
- namespace: Namespace
  Namespace for uniquely addressing this dynamic property.
  
  See
  createNamespace
- options: {
      category?: string;
      description?: string;
      icon?: IconRef;
      id?: string;
      name: string;
      propsSchema: Schema;
      valueTypes?: PropertyValueType[];
      writable: boolean;
      useDynamicProperty(
          props: CurrentSchemaValues<Schema>,
      ): UseDynamicPropertyResult;
  }
  - Optionalcategory?: string
    Optional category for grouping this dynamic property in the HELIO IDE.
  - Optionaldescription?: string
    Description of this dynamic property that will appear in the IDE.
  - Optionalicon?: IconRef
    Optional icon to identify this dynamic property in the HELIO IDE.
    
    Example
    { name: 'Dinosaur' }
  - Optionalid?: string
    Internal ID of the dynamic property. This uniquely identifies the dynamic property within the extension and should never change. If this property is omitted, the dynamic property will be referenced by its name.
  - name: string
    Human-readable name of the dynamic property as it will appear in the HELIO IDE.
    
    Note: If no explicit id is provided, this value will also be used to create a unique id for the dynamic property.
    
    Changing the name in an extension update will break dynamic property references in existing projects.
    
    If you need to change the name, make sure to provide an id with the old name to ensure a smooth migration.
    
    Example
    Migrating dynamic property name.
    
    { name: 'New Dynamic Property Name', id: 'Old Dynamic Property Name', // ...other `createDynamicProperty` options... }
  - propsSchema: Schema
    Schema containing the properties this dynamic property accepts, created using the createPropsSchema function.
  - OptionalvalueTypes?: PropertyValueType[]
    What kinds of values does this dynamic property provide?
    
    This restricts the contexts in which the dynamic property is available. For example, dynamic properties that can produce strings can be used as labels, in outputs, etc.
    
    Example
    Dynamic Property can produce scalar values like strings, numbers, booleans, dates, etc.
    
    ['PrimitiveValue']
    
    Example
    Dynamic Property can produce either strings or numbers.
    
    ['String', 'Number']
    
    Example
    Dynamic Property can produce image URLs.
    
    ['Image']
    
    Default
    ['*']
  - writable: boolean
    Does this dynamic property support write operations?
    
    If set to false, elements like inputs will be automatically disabled when receiving values from this dynamic property.
    
    Note that a dynamic property might support writing but still want to dynamically enable/disable write access due to other factors. This can be done using the UseDynamic PropertyResult.canWrite | canWrite property returned from implementation of CreateDynamic PropertyOptions.useDynamic Property.
    
    See
    UseDynamic PropertyResult.canWrite
  - useDynamicProperty: function
    useDynamicProperty(props: CurrentSchemaValues<Schema>): UseDynamicPropertyResult
    Implementation of this dynamic property.
    
    Will be dynamically installed by HELIO as a React hook to allow for data subscription and other scenarios where data changes over time.
    
    Parameters
    props: CurrentSchemaValues<Schema>
    Returns UseDynamicPropertyResult
    Defined in types/dynamicProperty.ts:121
Returns CreateDynamicPropertyResult<Schema>
Since
1.0.0
Example
Create a new dynamic property
```
const property = createDynamicProperty(namespace, {
  name: 'Basic Property',
  propsSchema: createPropsSchema().initial({}),
  writable: false,
  valueTypes: ['NumericValue'],

  useDynamicProperty(_props) {
    return {
      valueType: values.Number(),
      value: 123,
      displayValue: '123',
      canRead: true,
      canWrite: false,
    };
  },
});
```
See
createNamespace
- Defined in functions/createDynamicProperty.ts:45