diff --git a/.travis.yml b/.travis.yml index 71e35b08..62c2fed2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,11 @@ language: node_js node_js: - "0.10" + - "0.12" + - "4.1" script: - grunt test - grunt teste2e + +sudo: false diff --git a/README.md b/README.md index 7bb8aee5..6f19f097 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Mithril is a client-side MVC framework - a tool to organize code in a way that i ### Light-weight -- Only 5kb gzipped, no dependencies +- Only 7kb gzipped, no dependencies - Small API, small learning curve ### Robust diff --git a/docs/comparison.md b/docs/comparison.md index 268c7cb7..fb24bcdd 100644 --- a/docs/comparison.md +++ b/docs/comparison.md @@ -6,7 +6,7 @@ This page aims to provide a comparison between Mithril and some of the most wide ### Code Size -One of the most obvious differences between Mithril and most frameworks is in file size: Mithril is around 8kb gzipped and has no dependencies on other libraries. +One of the most obvious differences between Mithril and most frameworks is in file size: Mithril is around 7kb gzipped and has no dependencies on other libraries. Note that while a small gzipped size can look appealing, that number is often used to "hide the weight" of the uncompressed code: remember that the decompressed Javascript still needs to be parsed and evaluated on every page load, and this cost (which can be in the dozens of milliseconds range for some frameworks in some browsers) cannot be cached. diff --git a/docs/getting-started.md b/docs/getting-started.md index b2710ad5..7ee6f431 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,7 +4,7 @@ Mithril is a client-side Javascript MVC framework, i.e. it's a tool to make application code divided into a data layer (called **M**odel), a UI layer (called **V**iew), and a glue layer (called **C**ontroller) -Mithril is around 8kb gzipped thanks to its [small, focused, API](mithril.md). It provides a templating engine with a virtual DOM diff implementation for performant rendering, utilities for high-level modelling via functional composition, as well as support for routing and componentization. +Mithril is around 7kb gzipped thanks to its [small, focused, API](mithril.md). It provides a templating engine with a virtual DOM diff implementation for performant rendering, utilities for high-level modelling via functional composition, as well as support for routing and componentization. The goal of the framework is to make application code discoverable, readable and maintainable, and hopefully help you become an even better developer. diff --git a/docs/layout/index.html b/docs/layout/index.html index b85f236d..7b34ad28 100644 --- a/docs/layout/index.html +++ b/docs/layout/index.html @@ -50,7 +50,7 @@

Light-weight

diff --git a/mithril.d.ts b/mithril.d.ts index d89dde59..a5c24a6e 100644 --- a/mithril.d.ts +++ b/mithril.d.ts @@ -28,22 +28,6 @@ declare module _mithril { MithrilComponent> ): MithrilVirtualElement; - /** - * Initializes a component for use with m.render, m.mount, etc. - * - * @param component A component. - * @param args Arguments to optionally pass to the component. - * @return A component. - * - * @see m.render - * @see m.mount - * @see m - */ - ( - component: MithrilComponent, - ...args: any[] - ): MithrilComponent; - /** * Creates a virtual element for use with m.render, m.mount, etc. * @@ -67,18 +51,121 @@ declare module _mithril { * Initializes a component for use with m.render, m.mount, etc. * Shorthand for m.component. * - * @param selector A component. - * @param args Arguments to optionally pass to the component. - * @return A component. + * @param component A mithril component. + * @return A mithril component. * * @see m.render * @see m.mount * @see m.component */ - ( - component: MithrilComponent, - ...args: any[] - ): MithrilComponent; + ( + component: MithrilComponent + ): MithrilComponent; + + /** + * Initializes a component for use with m.render, m.mount, etc. + * Shorthand for m.component. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m.component + */ + ( + component: ParameterizedMithrilComponent, + arg1: T1 + ): MithrilComponent; + + /** + * Initializes a component for use with m.render, m.mount, etc. + * Shorthand for m.component. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @param arg2 Second argument to bind to the component. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m.component + */ + ( + component: ParameterizedMithrilComponent, + arg1: T1, + arg2: T2 + ): MithrilComponent; + + /** + * Initializes a component for use with m.render, m.mount, etc. + * Shorthand for m.component. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @param arg2 Second argument to bind to the component. + * @param arg3 Third argument to bind to the component. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m.component + */ + ( + component: ParameterizedMithrilComponent, + arg1: T1, + arg2: T2, + arg3: T3 + ): MithrilComponent; + + /** + * Initializes a parameterized component for use with m.render, m.mount, etc. + * Shorthand for m.component. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @param arg2 Second argument to bind to the component. + * @param arg3 Third argument to bind to the component. + * @param arg4 Fourth argument to bind to the component. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m.component + */ + ( + component: ParameterizedMithrilComponent, + arg1: T1, + arg2: T2, + arg3: T3, + arg4: T4 + ): MithrilComponent; + + /** + * Initializes a parameterized component for use with m.render, m.mount, etc. + * Shorthand for m.component. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @param arg2 Second argument to bind to the component. + * @param arg3 Third argument to bind to the component. + * @param arg4 Fourth argument to bind to the component. + * @param args Additional optional arguments which are not type checked. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m.component + */ + ( + component: ParameterizedMithrilComponent, + arg1: T1, + arg2: T2, + arg3: T3, + arg4: T4, + ...args:any[] + ): MithrilComponent; /** * Creates a getter-setter function that wraps a Mithril promise. Useful @@ -149,18 +236,116 @@ declare module _mithril { /** * Initializes a component for use with m.render, m.mount, etc. * - * @param selector A component. - * @param args Arguments to optionally pass to the component. - * @return A component. + * @param component A mithril component. + * @return A mithril component. * * @see m.render * @see m.mount * @see m */ - component( - component: MithrilComponent, + component( + component: MithrilComponent + ): MithrilComponent; + + /** + * Initializes a parameterized component for use with m.render, m.mount, etc. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m + */ + component( + component: ParameterizedMithrilComponent, + arg1: T1 + ): MithrilComponent; + + /** + * Initializes a parameterized component for use with m.render, m.mount, etc. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @param arg2 Second argument to bind to the component. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m + */ + component( + component: ParameterizedMithrilComponent, + arg1: T1, + arg2: T2 + ): MithrilComponent; + + /** + * Initializes a parameterized component for use with m.render, m.mount, etc. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @param arg2 Second argument to bind to the component. + * @param arg3 Third argument to bind to the component. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m + */ + component( + component: ParameterizedMithrilComponent, + arg1: T1, + arg2: T2, + arg3: T3 + ): MithrilComponent; + + /** + * Initializes a parameterized component for use with m.render, m.mount, etc. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @param arg2 Second argument to bind to the component. + * @param arg3 Third argument to bind to the component. + * @param arg4 Fourth argument to bind to the component. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m + */ + component( + component: ParameterizedMithrilComponent, + arg1: T1, + arg2: T2, + arg3: T3, + arg4: T4 + ): MithrilComponent; + + /** + * Initializes a parameterized component for use with m.render, m.mount, etc. + * + * @param component A parameterized component. + * @param arg1 First argument to bind to the component. + * @param arg2 Second argument to bind to the component. + * @param arg3 Third argument to bind to the component. + * @param arg4 Fourth argument to bind to the component. + * @param args Additional optional arguments which are not type checked. + * @return A component bound with the supplied arguments. + * + * @see m.render + * @see m.mount + * @see m + */ + component( + component: ParameterizedMithrilComponent, + arg1: T1, + arg2: T2, + arg3: T3, + arg4: T4, ...args: any[] - ): MithrilComponent; + ): MithrilComponent; /** * Trust this string of HTML. @@ -599,6 +784,30 @@ declare module _mithril { view(ctrl: T): MithrilVirtualElement; } + /** + * This represents a parameterized MithrilComponent with up to six parameters, + * intended to be instantiated via m.component(). + * + * @see m + * @see m.component + */ + interface ParameterizedMithrilComponent { + /** + * The component's controller. + * + * @see m.component + */ + controller: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, ...args: any[]) => TController; + + + /** + * creates a view out of virtual elements. + * + * @see m.component + */ + view(ctrl: TController, arg1: T1, arg2: T2, arg3: T3, arg4: T4, ...args:any[]): MithrilVirtualElement; + } + /** * This is the base interface for property getter-setters *