-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Doc 12584 new javascript plugin doc (#916)
* DOC-12584: Dead file removal * DOC-12584: What's new page addition * DOC-12584: Move Cordova down Move Cordova to bottom of nav as it's not being actively maintained. * DOC-12584: What's new addition Added plugin announcement to what's new page. * DOC-12584: Update JavaScript quickstart page. Changelist: -- Removing 404 ionic link -- Updating Ionic and React sections to include new plugin documentation links and the new react example project * DOC-12584: Update and replace existing documentation Replaced existing doc with new content for the ionic and react doc pages * DOC-12584: Remove cordova plugin content from docs Remove doc page, nav entry and quickstart links * DOC-12584: Doc feedback Remove features and limitations from react as already in devrel doc Add support information Add missing links * DOC-12584: Dead code removal * DOC-12584: Applying PM and docs feedback * DOC-12584: Docs feedback tidy up * Apply suggestions from code review Co-authored-by: Simon Dew <[email protected]> * DOC-12584: More detailed link context * Update modules/javascript/pages/react.adoc Co-authored-by: Ray Offiah <[email protected]> --------- Co-authored-by: Simon Dew <[email protected]> Co-authored-by: Ray Offiah <[email protected]>
- Loading branch information
3 people
authored
Oct 2, 2024
1 parent
a91c0be
commit bc96d24
Showing
7 changed files
with
44 additions
and
261 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,3 @@ | ||
| .xref:javascript:quickstart.adoc[Javascript] | ||
| * xref:javascript:ionic.adoc[] | ||
| * xref:javascript:cordova.adoc[] | ||
| * xref:javascript:react.adoc[] |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,48 @@ | ||
| = React Native | ||
| :page-partials: | ||
| :page-edition: Public Preview | ||
| :page-toclevels: 2@ | ||
| :description: Using Couchbase Lite with Javascript applications | ||
| :description: The React Native plugin for Couchbase Lite is now in public preview. This is an open-source, community-supported project developed by Couchbase. | ||
|
|
||
| include::partial$_set_page_context_for_javascript.adoc[] | ||
|
|
||
| :param-abstract: If you are building mobile or desktop applications using web technologies such as JavaScript/HTML/CSS, there are options for using Couchbase Lite as an embedded database within your app. | ||
| :param-related: xref:ionic.adoc[] | xref:cordova.adoc[] | ||
| include::{root-partials}_show_page_header_block.adoc[] | ||
| == Overview | ||
|
|
||
| Couchbase Lite Enterprise Edition for React Native is a Native Module implementation that uses TypeScript. | ||
| This public preview release enables developers using React to integrate Couchbase Lite into their mobile applications, ensuring they can build offline-first, cross-platform solutions with ease. | ||
|
|
||
| :tutorial: https://github.com/couchbaselabs/userprofile-couchbase-mobile-reactnative/blob/main/README.md | ||
| More information on React Native Native Modules can be found at https://cbl-reactnative.dev/[Couchbase Lite Enterprise Edition for React Native]. | ||
|
|
||
| :docs: https://reactnative.dev/docs/native-modules-intro | ||
| == Important Notes | ||
|
|
||
| :ref_implementation: https://github.com/couchbaselabs/couchbase-lite-react-native-module/ | ||
| * Platform Support - This plugin currently only supports iOS and Android platforms. Web, Windows, and macOS are not currently supported. | ||
|
|
||
| NOTE: Couchbase Lite for React Native is a community-driven project without official support from Couchbase. | ||
| * Couchbase Community Supported - This open-source plugin is Couchbase Community supported. | ||
| Note that the Couchbase Lite binary linked to the plugin is Couchbase Lite Enterprise Edition (EE) and its use is guided by the terms and conditions of the https://www.couchbase.com/2018-04-30v3_License_Agreement/[Couchbase Lite Enterprise license agreement]. | ||
|
|
||
| // == Introduction | ||
| NOTE: _**Couchbase Community Supported**_ is an Open source integration that is developed by Couchbase. Issues related to the integration can be raised in the relevant GitHub repositories or via Couchbase forums or Discord. Support is provided best effort by development team. | ||
| For more information, see xref:cloud:third-party:integrations.adoc#support-model[Support Models]. | ||
|
|
||
| == Getting Started | ||
| You can use the links below to help you get started with the React Native plugin for Couchbase Lite: | ||
|
|
||
| // tag::summary[] | ||
| To use Couchbase Lite as an embedded database within your React Native app, you need a way to access Couchbase Lite's iOS and Android native APIs from within it. | ||
| * https://cbl-reactnative.dev[Official Documentation]. | ||
|
|
||
| React Native's _NativeModule_ system provides an answer, exposing instances of native classes to JavaScript (JS) as JS objects. | ||
| * https://github.com/couchbase-examples/expo-cbl-travel[Example Project] - A hands-on demonstration using Expo to showcase Couchbase Lite in a React Native app. | ||
|
|
||
| // end::summary[] | ||
| * https://github.com/Couchbase-Ecosystem/cbl-reactnative[Project Repository]. | ||
|
|
||
| === Why Use Expo? | ||
|
|
||
| // == Functionality | ||
| Couchbase recommends using Expo. | ||
| Expo makes working with React Native simpler and more efficient. | ||
| You can find information on the prerequisites and setup, including Expo configuration at https://cbl-reactnative.dev/StartHere/prerequisites[Couchbase Lite for React Native Prerequisites]. | ||
|
|
||
| == Next Steps | ||
|
|
||
| {docs}[React Native Modules] | ||
| allow mobile apps written in React Native to access native platform APIs. | ||
| So in order to use Couchbase Lite within your React Native apps, you should implement a React Native plugin that exports the Couchbase Lite Android and iOS APIs to Javascript. | ||
| It is typical to start with exporting the minimal subset of APIs that your app needs. | ||
| As this is a community-supported project, we encourage you to explore, test, and provide feedback to help us improve the React Native plugin for Couchbase Lite. Feel free to file issues through the https://github.com/Couchbase-Ecosystem/cbl-reactnative/issues[GitHub issue tracker], our https://www.couchbase.com/blog/couchbase-on-discord/[Community Discord] or https://www.couchbase.com/forums/[Couchbase Forums]. | ||
|
|
||
| .Resources | ||
| **** | ||
| Docs:: | ||
| *{docs}[Docs:]* ({docs}) | ||
| Tutorial:: | ||
| This tutorial is based on our series of _Getting Started_ User Profile app tutorials. + | ||
| *{tutorial}[Get Started:]* ({tutorial}) | ||
| Reference Implementation:: | ||
| {ref_implementation}[Reference Implementation] ({ref_implementation}) | ||
|
|
||
| // DO NOT EDIT -- Footer Related Content Block | ||
| // include::{root-partials}block-related-content-std.adoc[] | ||
| // DO NOT EDIT | ||