Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brodycj/cordova-plugin-syr-core-experimental
Native Cordova view plugin using syr core - EXPERIMENTAL
https://github.com/brodycj/cordova-plugin-syr-core-experimental
Last synced: about 2 months ago
JSON representation
Native Cordova view plugin using syr core - EXPERIMENTAL
- Host: GitHub
- URL: https://github.com/brodycj/cordova-plugin-syr-core-experimental
- Owner: brodycj
- License: mit
- Created: 2018-09-07T01:42:18.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2020-04-02T19:31:08.000Z (almost 5 years ago)
- Last Synced: 2024-07-31T00:17:17.753Z (6 months ago)
- Language: Java
- Size: 6.39 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Native Cordova view using syr core - experimental work
Experimental adaptations to syr.js core to work as a Cordova plugin for Android and iOS, with help from some extra WebView hacks
using local webpack dev server for now
LICENSE: MIT
## Usage
Note: these directions assume knowledge of Cordova framework and some familiarity with syr.js.
On a Cordova project:
- Add this plugin to the Cordova project
- Update the application JavaScript to execute the following after receiving the `deviceready` event:
```js
cordova.exec(null, null, 'SYRPlugin', 'start', [])
```
Do the following steps on before running the app
(from [Running the local Sample](#running-the-local-sample) section below):
* Clone the repo
* `npm install`
* `npm run serve`
Then run the app on Android emulator or iOS simulator.
## Demo project
Cordova demo project along with instructions at:
### Screenshots
With black number labels as proposed in [syrjs / core#274](https://github.com/syrjs/core/pull/274)
#### Android
#### iOS
## Major issues
* Use of extra dialog on Android breaks operation of back button
* Images do not seem to work
## Other TODO items
* Export cleaner JavaScript startup API
* Fix to use native HTML and JavaScript from assets instead of local webpack server
* Support for using bundled JavaScript part of syr.js core within a Cordova project
* Fix SyrBridge to work with existing Cordova WebView on Android and iOS
* Remove extra Android and iOS artifacts not needed
## For future consideration
* Support for concurrent native views, possibly with multiple JavaScript execution contexts
## End of Cordova plugin documentation
# original documentation for syr js - development version
[](https://travis-ci.org/syrjs/syr)
[](https://www.npmjs.com/package/@syr/core)
[](https://coveralls.io/github/dmikey/syr?branch=master)
[](https://syr.js.org)
Build dynamic UIs for Native Platforms, with less than 200kb of extra libraries!
The goal to provide, Native SDK developers the benefits of the React Native API, with a much smaller footprint and reduced complexity.
Easily package Syr with your Native SDKs and Apps and drive dynamic updatable experiences with JavaScript.
Syr uses a React like API with a custom JS API bridge, that allows an SDK developer to bundle an updatable experience through Apple's iTunes terms.
### help
gitter: https://gitter.im/syrjs/general
otherwise open an issue.
### breaking change
`syr` moved to scoped packages. Please move to `@syr/core`.
### Read the Docs
https://syr.js.org
### Getting Started
Install
```bash
npm i @syr/core
```
### Roadmap
Even (starting with 2) releases are stable, Odd (starting with 1) releases are development builds. Every fourth (starting with 4.0.0) release is an LTS and will be branched as well as tagged.
* LTS Currently means support beyond 2 Stable Releases. Support for 4.0.0 will be sunset when 8.0.0 is released, as 6.0.0 will become the lowest LTS version.
How contributions will be scheduled for intake starting with version 2.0.0.
Major
* Any Native Code Change in the Core Library Results in an Immediate Major Change.
* Any Guest deprecations must force a major change.
Minor
* Any Guest System Rendering Changes.
* If new dependent features are changed, which causes instability it must be promoted to `Major` release schedule.
Patch
* Corrects undesired consistent behavior.
* Adds new features without collision
https://github.com/syrjs/syr/milestones
### Development Example
### Running the local Sample
First steps:
* Clone the repo
* `npm install`
* `npm run serve`
To run on iOS simulator:
* Open [ios/SyrNativeSample](https://github.com/dmikey/syr/tree/master/ios/SyrNativeSample/SyrNativeSample.xcodeproj) in xcode
* Run the project in xcode.
To run on Android emulator, using Gradle:
* `cd android && ./gradlew installDebug`
* run the app on the Android emulator
## Contributors
[
](https://github.com/dmikey) |[
](https://github.com/MSiddharthReddy) |[
](https://github.com/pvenkatakrishnan) |[
](https://github.com/gabrielcsapo) |[
](https://github.com/edwinwebb) | [
](https://github.com/Sherman-Chen)
:---:|:---:|:---:|:---:|:---:|:---:|
[dmikey](https://github.com/dmikey)|[MSiddharthReddy](https://github.com/MSiddharthReddy)|[pvenkatakrishnan](https://github.com/pvenkatakrishnan)|[gabrielcsapo](https://github.com/gabrielcsapo)| [edwinwebb](https://github.com/edwinwebb)|[Sherman-Chen](https://github.com/Sherman-Chen)
