You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(all): 🐛 fix bugs, make pjax and transitionmanager support config as options, fix readme, etc
fix bugs, make pjax and transitionmanager support app config as options, fix readme grammar issues, add support for gitpod dockerfiles, remove ./vscode folder, fix LICENCE
[](https://gitpod.io/#https://github.com/okikio/native/tree/master/packages/native)
8
+
9
+
Once Gitpod has booted up, go to the `./packages/native/build folder` and start tweaking and testing to your hearts content.
10
+
11
+
12
+
*Note: if an error occurs that stops the build script, just type into the terminal*
13
+
```bash
14
+
ultra pnpm demo:watch --filter *native
15
+
```
7
16
8
17
## Table of Contents
9
18
-[Native](#native)
@@ -15,39 +24,46 @@ You can play with `native` using Gitpod:
15
24
-[@okikio/native](#okikionative)
16
25
-[Usage](#usage)
17
26
-[Demo](#demo)
27
+
-[Contributing](#contributing)
28
+
-[Licence](#licence)
18
29
19
30
## Getting started
20
-
21
31
`native` is a monorepo with 4 smaller packages within it, they are:
22
32
23
33
24
34
### [@okikio/manager](./packages/manager)
25
-
* A superset of the Map class, it gives Map superpowers. The Map class is the most efficient way to handle large amounts of controlled data, but it has some inconvient quirks that would be annoying to just contantly think about, so I built this package to avoid some of it's quirks.
26
-
**Note: you can install it as a seperate package from the rest of the native framework.*
35
+
* A superset of the Map class, it gives Map superpowers. The Map class is the most efficient way to handle large amounts of controlled data, but it has some inconvient quirks that would be annoying to handle, so I built this package to avoid some of it's quirks.
36
+
**Note: you can install it as a seperate package from the rest of the `native` framework.*
27
37
*[Read more...](./packages/manager/README.md)
28
38
29
39
30
40
### [@okikio/emitter](./packages/emitter)
31
-
* A small Event Emitter written in typescript with performance and ease of use in mind. It's pretty self explanitory, there are millions of event emitters like this one, the only difference is that this one is optimized for the native framework.
32
-
**Note: you can install it as a seperate package from the rest of the native framework.*
41
+
* A small event emitter written in typescript with performance and ease of use in mind. It's pretty self explanitory, there are millions of event emitters like this one, the only difference is that this one is optimized for use in the `native` framework.
42
+
**Note: you can install it as a seperate package from the rest of the `native` framework.*
33
43
*[Read more...](./packages/emitter/README.md)
34
44
35
45
36
46
### [@okikio/animate](./packages/animate)
37
-
* A truly native animation library that takes full advantage of the Web Animation API, to create amazingly pollished and native experiences on all devices. The animation library takes this approach because of the connundrum that occured when mobile devices started being built with 120hz screens. Before this point most devices were 60hz, so developers built for 60hz, but because 60hz was the default, users with 120hz screens missed out on a major selling point of their devices. To future proof animation in an easy to use and effiecient manner, I built this library as a light wrapper around the Web Animation API, that takes on conventional means for creating animation today, allowing developers to get started with modern animation today.
38
-
**Note: you can install it as a seperate package from the rest of the native framework.*
47
+
* A truly native animation library that takes full advantage of the Web Animation API to create amazingly pollished experiences on all devices. The animation library takes this approach because of the connundrum that occured when mobile devices started being built with 120hz screens. Before this point most devices were 60hz, so developers built for 60hz, but this caused many users to lose out on the benefits of their 120hz device. To future proof animation in an easy to use and effiecient manner, I built this library as a light wrapper around the Web Animation API, that takes on conventional means for creating animation today, allowing developers to get started with modern animation today.
48
+
**Note: you can install it as a seperate package from the rest of the `native` framework.*
39
49
*[Read more...](./packages/animate/README.md)
40
50
41
51
42
52
### [@okikio/native](./packages/native)
43
-
* This is the core component of the framework, it has all of the other packages built in. This package encourages the user to download/copy-and-paste the code into their development enviroment of choice, and tweak it to match their projects needs. This package like all other packages is built for es2020, it expects the user to use a build tool support older versions of browsers, the idea being most people are using evergreen browsers, so, why are web developers piling on polyfill code that most users don't need.
53
+
* This is the core component of the framework, it bundles all the other packages into iteself. This package encourages the user to download/copy-and-paste the code into their development enviroment of choice, and tweak it to match their projects needs. This package (like all other packages in the `native` framework) is built for ES2020, it expects the user to use a build tool to support older versions of browsers, the idea being most people are using evergreen browsers, so, why are web developers piling on polyfill code that most users don't need.
44
54
*[Read more...](./packages/native/README.md)
45
55
46
56
This framework works with the assumtion that the user will use a build tool and a polyfill library to ensure all components work in older browser, I suggest `esbuild`, `rollup`, or `webpack`, and for polyfills `babel` or `polyfill.io`.
47
57
48
58
## Usage
49
59
50
-
Located in [./packages/native/build](https://github.com/okikio/native/tree/master/packages/native/build), you will find multiple build files that can help you create your setup. The [pug folder](https://github.com/okikio/native/tree/master/packages/native/build/pug) contains [pug](https://pugjs.org/api/getting-started.html) files that format my html in a clean and clear way. The [sass folder](https://github.com/okikio/native/tree/master/packages/native/build/sass) contains [scss](https://sass-lang.com/guide) files that allow for modern css without the need of polyfills. The [ts folder](https://github.com/okikio/native/tree/master/packages/native/build/ts) contains [typescript](https://www.typescriptlang.org/) files that the framework runs on; typescript is used, because Intellisense is better with typescript. Outside the build folder, the [gulpfile.js](https://github.com/okikio/native/tree/master/packages/native/gulpfile.js) file, is part of my [gulp](https://gulpjs.com/) config, and is the tool I use to build the demo, for your project other tools should also work, with some amoount of work. Explore the files stated above to learn how to get started. Read more about `native` in the [@okikio/native README](./packages/native/README.md). Explore the other packages as well to learn how they all work together.
60
+
Located in [./packages/native/build](https://github.com/okikio/native/tree/master/packages/native/build), you will find multiple build files that can help you create your setup. The [/pug folder](https://github.com/okikio/native/tree/master/packages/native/build/pug) contains [pug](https://pugjs.org/api/getting-started.html) files that format my html in a clean and clear way. The [/sass folder](https://github.com/okikio/native/tree/master/packages/native/build/sass) contains [scss](https://sass-lang.com/guide) files that allow for modern css without the need of polyfills. The [/ts folder](https://github.com/okikio/native/tree/master/packages/native/build/ts) contains [typescript](https://www.typescriptlang.org/) files that the framework runs on; typescript is used because Intellisense is better with typescript. Outside the build folder, the [gulpfile.js](https://github.com/okikio/native/tree/master/packages/native/gulpfile.js) file, is part of my [gulp](https://gulpjs.com/) config, and is the tool I use to build the demo. For your project other tools should also work with some tweaks. Explore the files stated above to learn how to get started. Read more about `native` in the [@okikio/native README](./packages/native/README.md). Explore the other packages as well to learn how they all work together.
51
61
52
62
## Demo
53
63
> [View a demo →](https://okikio.github.io/native/packages/native/demo/)
64
+
65
+
## Contributing
66
+
If there is something I missed, a mistake, or a feature you would like added please create an issue or a pull request and I'll try to get to it.
67
+
68
+
## Licence
69
+
See the [LICENSE](./LICENSE) file for license rights and limitations (MIT).
0 commit comments