@xeito/core

Xeito - Harness the power of the web.

Xeito is a typescript framework for building web applications

Xeito Documentation

 

---

Xeito Core

This is the base library for Xeito Framework which provides the core functionality for the framework.

To find the full documentation and more links go to the main README file.

---

Installation

npm install @xeito/core

Exports:

Core Classes:

• Xeito: The main class that is used to create a new Xeito Application.
• XeitoComponent: The class components extend from.
• XeitoPlugin: The class plugins extend from.

Core Decorators:

• Action: Used to create an action for modifying elements.
• Component: Marks a class as a component and adds related functionality.
• Event: Creates a new event emitter in the component.
• Global: Allows access to global properties from inside a component.
• Pipe: Creates a new pipe for transforming data.
• Prop: Creates a new reactive property in the component.
• Ref: Syntactic sugar to access a ref of the template.
• State: Creates a reactive class property that triggers template updates.

Interfaces

• Emitter: The interface for event emitters.
• ActionMetadata: The interface for action metadata (decorator).
• ActionResult: The interface for action results (return value).
• ComponentMetadata: The interface for component metadata (decorator).
• ElementRef: The interface for element references (for Ref() decorator).
• EventConfig: The interface for event configuration (in Event() decorator).
• PipeMetadata: The interface for pipe metadata (decorator).
• PropChange: The interface for prop changes (parameter of the onPropChange() method).
• WatchUpdate: The interface for watch updates (parameter of a method decorated with @Watch()).

Re-exports from µhtml:

• html: Tag for template literals that creates the template.
• svg: Tag for template literals for svg.
• render: Used to render the template in the specified element [Internal].
• Hole: [Internal].
• Renderable: [Internal].
• TemplateFunction: [Internal].