@intuiface/core • Docs

---

@intuiface/core

This library will enables you to create custom interface assets that can be used in your Intuiface experiences.

In @intuiface/core, we use TypeScript decorators to declare Properties, Triggers and Actions exposed in Intuiface Composer. You can find all available decorators in this documentation.

@intuiface/core also exposes services that will help you access low level information (device's id, name, os...), hardware, cache... in an easy and cross-platform way.

Use the @intuiface/interface-asset to create and initialize your project workspace. Then you can use IntuifaceElement and @Asset decorator to declare your interface asset and @Property, @Trigger and @Action decorators to customize it. See @Asset example for a squeleton class of a custom interface asset.

Remarks

Before reading how to create interface assets and declare Properties, Triggers, Actions and Parameters, please note that we choose to use the camelCase naming convention.

Enumerations

• CacheStrategy
• CacheScope

Classes

• Watchable
• IntuifaceCollection
• ElementContainer
• IntuifaceElement

Interfaces

• IDisposable
• IActionOptions
• IComputorOptions
• IElementOptions
• IParameterOptions
• IPropertyOptions
• ITriggerOptions
• ICollectionConfiguration
• CacheEntry
• CacheOptions
• DownloadProgress

Decorators

• Action
• Computor
• Asset
• Collection
• InternalProperty
• Parameter
• Property
• Trigger

Services

• CacheService
• EnvironmentService
• SystemInfoService
• UsbSerialService

Types

• Color
• IConvertibleType
• Typeface
• Font
• LinearGradient
• Path
• RadialGradient
• Resource
• SolidColor
• Time

Help

Found a problem, a bug? Or need some help?
Please do not create an issue in Github! Ask us via our Support page : https://support.intuiface.com/