Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidation Providers and Hooks #3356

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
76f8749
testing providers and hooks
osharaf-mdb Jul 25, 2024
22f66f3
initial providers and hooks page
osharaf-mdb Jul 25, 2024
b092218
formatting
osharaf-mdb Jul 25, 2024
61afc28
re-formatted
osharaf-mdb Jul 25, 2024
6cb92c3
re-formatted
osharaf-mdb Jul 25, 2024
5ca9db1
added code example
osharaf-mdb Jul 25, 2024
da0e86d
added code example
osharaf-mdb Jul 25, 2024
44d996d
test
osharaf-mdb Jul 25, 2024
dae36ce
lol
osharaf-mdb Jul 25, 2024
9b15971
added api references
osharaf-mdb Jul 25, 2024
574a124
first round of reviews
osharaf-mdb Jul 30, 2024
34b0190
added hooks
osharaf-mdb Jul 31, 2024
d790543
small
osharaf-mdb Jul 31, 2024
b3aa876
fleshed out and adjusted props
osharaf-mdb Jul 31, 2024
f0ab34e
added alternate realm configurations
osharaf-mdb Jul 31, 2024
dc7c2f1
switched configuration intro
osharaf-mdb Jul 31, 2024
c9de1e5
added configuration code examples
osharaf-mdb Jul 31, 2024
aac36eb
fixed small formatting issues
osharaf-mdb Jul 31, 2024
d3a2585
testing app provider hooks condesning
osharaf-mdb Jul 31, 2024
a90048b
auth email password methods
osharaf-mdb Jul 31, 2024
0f49482
reordered app provider hooks
osharaf-mdb Jul 31, 2024
6db5790
deleted files
osharaf-mdb Jul 31, 2024
f27b854
some feedback
osharaf-mdb Aug 4, 2024
f967226
took away tabs
osharaf-mdb Aug 4, 2024
22f2650
testing table
osharaf-mdb Aug 4, 2024
4f494e2
finished first table
osharaf-mdb Aug 4, 2024
b1c9d0c
linkned to other pages
osharaf-mdb Aug 4, 2024
e6a2192
linkned to other pages
osharaf-mdb Aug 4, 2024
b50c034
linkned to other pages
osharaf-mdb Aug 4, 2024
fd474fa
more changes
osharaf-mdb Aug 5, 2024
61a208c
fixed createRealmContext section
osharaf-mdb Aug 5, 2024
753e596
fixed create context
osharaf-mdb Aug 5, 2024
45c2e43
code examples for all three providers
osharaf-mdb Aug 5, 2024
2f3d9fa
fixed page links
osharaf-mdb Aug 5, 2024
d91a3fa
fixed realm to atlas or database
osharaf-mdb Aug 5, 2024
3c4d085
switched to procedure formatting
osharaf-mdb Aug 5, 2024
b85b388
updated files to reflect TOC
osharaf-mdb Aug 6, 2024
002fa93
fixed build errors
osharaf-mdb Aug 6, 2024
42cd862
deleted unused test
osharaf-mdb Aug 6, 2024
a77af23
most of the final changes have been made
osharaf-mdb Aug 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import React from "react";
import { APP_ID } from "../realm.config.json";
import { AppProvider, UserProvider, RealmProvider, useRealm, useUser } from "@realm/react";

export const AppWrapper = () => {
return (
<AppProvider id={APP_ID}> {/* pass in your App ID as a prop */}
<UserProvider>
<RealmProvider>
{/* call any app components here */}
</RealmProvider>
</UserProvider>
</AppProvider>
);
};
7 changes: 5 additions & 2 deletions source/frameworks.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,22 @@ Build with Frameworks
.. toctree::
:titlesonly:

React </frameworks/react>
React Native </frameworks/react-native>
Electron </frameworks/electron>
Flutter </frameworks/flutter>
Maui </frameworks/maui>
.NET </frameworks/dotnet>
React Native </frameworks/react-native>
SwiftUI </frameworks/swiftui>

The following pages contain information about building with specific
frameworks using Atlas Device SDK:

- :ref:`sdks-build-with-react`
- :ref:`sdks-build-with-react-native`
- :ref:`sdks-build-with-electron`
- :ref:`sdks-build-with-flutter`
- :ref:`sdks-build-with-maui`
- :ref:`sdks-build-with-dotnet`
- :ref:`sdks-build-with-react-native`
- :ref:`sdks-build-with-swiftui`
- :ref:`sdks-build-with-swiftui`
30 changes: 30 additions & 0 deletions source/frameworks/react.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _sdks-build-with-react:

================
Build with React
================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

.. toctree::
:titlesonly:

Install </frameworks/react/install>
Quick Start </frameworks/react/quick-start>
Providers & Hooks </frameworks/react/providers-hooks>
Model Data </frameworks/react/model-data>
Open & Manage Database Files </frameworks/react/manage-database-files>
Read & Write Data </frameworks/react/read-write>
React to Changes </frameworks/react/react-to-changes>
Access Atlas </frameworks/react/access-atlas>
Manage Users </frameworks/react/manage-users>
Sync Data </frameworks/react/sync-data>
Test & Debug </frameworks/react/test-debug>
API Reference </frameworks/react/api-reference>

Placeholder page for information about building with React. (This may
be a directory depending on how much content we have/need.)
14 changes: 14 additions & 0 deletions source/frameworks/react/access-atlas.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _sdks-react-access-atlas:

============
Access Atlas
============

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

Placeholder page for information about building with @realm/react. (This may
be a directory as we have two pages for this?)
10 changes: 10 additions & 0 deletions source/frameworks/react/api-reference.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _sdks-react-api-reference:

===================================
API Reference
===================================

.. toctree::
:titlesonly:

JavaScript SDK Reference (@realm) <https://www.mongodb.com/docs/realm-sdks/js/latest/>
14 changes: 14 additions & 0 deletions source/frameworks/react/install.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _sdks-react-install:

===================================
Install @realm/react in a React App
===================================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

Placeholder page for information about building with @realm/react. (This may
be a directory as we have two pages for this?)
14 changes: 14 additions & 0 deletions source/frameworks/react/manage-database-files.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _sdks-react-manage-database-files:

============================
Open & Manage Database Files
============================

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

Placeholder page for information about building with @realm/react. (This may
be a directory as we have two pages for this?)
14 changes: 14 additions & 0 deletions source/frameworks/react/manage-users.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _sdks-react-manage-users:

============
Manage Users
============

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

Placeholder page for information about building with @realm/react. (This may
be a directory as we have two pages for this?)
14 changes: 14 additions & 0 deletions source/frameworks/react/model-data.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _sdks-react-model-data:

==========
Model Data
==========

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

Placeholder page for information about building with @realm/react. (This may
be a directory as we have two pages for this?)
Loading
Loading