https://github.com/eeue56/speak-to-the-natives

Examples of Elm Native code
https://github.com/eeue56/speak-to-the-natives

Last synced: about 1 month ago
JSON representation

Examples of Elm Native code

• Host: GitHub
• URL: https://github.com/eeue56/speak-to-the-natives
• Owner: eeue56
• License: bsd-3-clause
• Created: 2015-08-27T13:19:39.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-09T22:11:06.000Z (over 9 years ago)
• Last Synced: 2024-05-21T12:33:41.912Z (8 months ago)
• Language: Elm
• Homepage:
• Size: 146 KB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# speak-to-the-natives

This project aims to provide simple examples of how to do things with Elm's Natives. Elm's natives are [undocumented on purpose](https://groups.google.com/forum/#!topic/elm-discuss/DPuUPv72abc) and subject to change. While Elm is currently a solid way of creating web projects, there is still limited functionality that is best aided by reaching out into JS and either interecting with the DOM or performing some strange JS function that currently has no wrapper in Elm.

[Ports](http://elm-lang.org/guide/interop#ports) are already a way of interecting with JS. However, it is limited compared the accesibility possible through using Natives. If something is defined as a function through natives, then it is simpler for the developer to understand - there's no need to introduce the ports keyword, nor have any level of JS if your API is well defined. Ports currently support a limited set of types to be sent through them - while you can send records and JSON values, sometimes it's nicer to just send Dicts when you need them.

```

The types of values that can flow through outbound ports include:

Ints, Floats, Bools, Strings, Maybes, Lists, Arrays, Tuples,

Json.Values, and concrete records.

```

Any examples here exist only as a discussion point - they aren't to be used in the real world. In the Maths module, I have put purposely badly-named functions such as adding/subtracting so they are clearly not part of Basics or anything other real module.

Native is set to change in Elm 0.16, so this document will be updated to reflect that. I will tag the final version before updating with 0.15.1 so people can find that.

Template

--------

Below is an example template of a Native module. This should live in a file called .js, inside a folder called `Native`.

Swap out `Maths` for the name of the template you're creating.

```javascript

Elm.Native.Maths = {};

Elm.Native.Maths.make = function(localRuntime) {

    localRuntime.Native = localRuntime.Native || {};

    localRuntime.Native.Maths = localRuntime.Native.Maths || {};

    if (localRuntime.Native.Maths.values)

    {

        return localRuntime.Native.Maths.values;

    }

    return Elm.Native.Maths.values = {

    };

};

```