Merge pull request #412 from reown-com/feature/flutter_docs_update

Flutter docs update

Author: quetool

appkit/flutter/core/actions.mdx

@@ -17,20 +17,28 @@ ValueListenableBuilder<String>(
 
 ```
 
-### - Launch the current wallet
+### Launch block explorer
 
-If you connected your dApp through deep linking to a Wallet app you can launch that wallet app with the following:
+You can open the selected chain's block explorer easily:
 
 ```javascript
-_appKitModal.launchConnectedWallet();
+_appKitModal.launchBlockExplorer();
 ```
 
-### - Launch block explorer
+### - Reconnect relay
 
-You can open the selected chain's block explorer easily:
+In most cases it shouldn't be needed as it is called internally but this method is useful to reconnect the relay when internet connection is back after inactivity.
 
 ```javascript
-_appKitModal.launchBlockExplorer();
+await _appKitModal.reconnectRelay();
+```
+
+### - Load account data such as balance and identity
+
+In most cases it shouldn't be needed as it is called internally but this method is useful to reload account data such as balance and identity. Particularly useful after a transaction.
+
+```javascript
+await _appKitModal.loadAccountData();
 ```
 
 ### - Send an RPC request
@@ -75,6 +83,16 @@ _appKitModal.getApprovedMethods();
 _appKitModal.getApprovedEvents();
 ```
 
+### - Request switch to or add chain
+
+If you add a new chain on an ongoing session you should call `requestSwitchToChain()` so the wallet can add it as well. Otherwise it will just be not usable.
+`requestAddChain()` is called automatically by `requestSwitchToChain()` in case of failing with the proper error from the wallet.
+
+```javascript
+await _appKitModal.requestSwitchToChain(ReownAppKitModalNetworkInfo newChain);
+await _appKitModal.requestAddChain(ReownAppKitModalNetworkInfo newChain);
+```
+
 ### - Interact with Smart Contracts
 
 <Info>

appkit/flutter/core/custom-chains.mdx

@@ -10,6 +10,11 @@ This means that if you intend to support just EVM and Solana networks then no fu
 
 However, with extra configuration to `ReownAppKitModalNetworks` and `optionalNamespaces` you can connect to whatever other network you'd like.
 
+<Note>
+If you are starting from scratch, you can avoid this by using our [CLI tool](https://pub.dev/packages/reown_cli) and passing the chains you want to support as arguments.
+</Note>
+
+
 For instance, if you want to support also Polkadot blockchain then first add Polkadot to the supported networks list:
 
 ```javascript

appkit/flutter/core/email.mdx

@@ -21,15 +21,15 @@ Remember to whitelist your dapp's iOS's bundleId and Android's packageName in yo
 3. Add your iOS Bundle ID and your Android Package Name
 </Warning>
 
-<Warning>
+<Note>
 Email and Social login are supported only on EVM networks and Solana.
-</Warning>
+</Note>
 
 ## Integration
 
 In order to support Email and Social Wallets creation just set `featuresConfig:` parameter in `ReownAppKitModal` initialization.
 
-```javascript {14-23}
+```javascript {14-27}
 final _appKitModal = ReownAppKitModal(
   context: context,
   projectId: '{YOUR_PROJECT_ID}',
@@ -44,26 +44,29 @@ final _appKitModal = ReownAppKitModal(
     ),
   ),
   featuresConfig: FeaturesConfig(
-    email: true,
     socials: [
-      AppKitSocialOption.Farcaster,
+      AppKitSocialOption.Email,
       AppKitSocialOption.X,
+      AppKitSocialOption.Google,
       AppKitSocialOption.Apple,
       AppKitSocialOption.Discord,
+      AppKitSocialOption.GitHub,
+      AppKitSocialOption.Facebook,
+      AppKitSocialOption.Twitch,
+      AppKitSocialOption.Telegram,
     ],
-    showMainWallets: false,
+    showMainWallets: false, // OPTIONAL - true by default
   ),
 );
 ```
 
 ## Options
 
-- **_email `bool`_** : This boolean defines whether you want to enable email login. Default `true`
-- **_socials `List<AppKitSocialOption>`_** : This list contains the list of social platforms that you want to enable for user authentication. The platforms in the example include Farcaster, X, Discord. Is empty by default, it means that no social options is enabled.
-- **showMainWallets `bool`\_** : This boolean defines whether you want to show the main wallet options on the first connect screen. If this is `false` it will show a button that directs you to a new screen displaying all available wallets. Default `true`.
+- **_socials `List<AppKitSocialOption>`_** : This list contains the list of social platforms that you want to enable for user authentication. Is empty by default, it means that no social options is enabled. The buttons in the modal will be shown in the same order you configure the list.
+- **_showMainWallets `bool`_** : This boolean defines whether you want to show the main wallet options on the first connect screen. If this is `false` it will show a button that directs you to a new screen displaying all available wallets. Default `true`.
 
 <Info>
-In order for Email Wallet to work properly, either `AppKitModalConnectButton()` or `AppKitModalAccountButton()` has to be instantiated during the whole lifetime of the app.
+In order for Farcaster to work properly, either `AppKitModalConnectButton()` or `AppKitModalAccountButton()` has to be instantiated during the whole lifetime of the app.
 
 If you already use them then nothing else has to be done, but in case you don't use them but still want to support Email & Social Wallets you would have to instantiate and hide them as follows:
 
@@ -81,10 +84,6 @@ AppKitModalAccountButton(
 
 ## User Flow
 
-1. Users will be able to connect to you application by simply using an email address. AppKit will send to them a One Time Password (OTP) to copy and paste in the modal, which will help to verify the user's authenticity. This will create a non-custodial wallet for your user which will be available in any application that integrates AppKit and Email Wallets.
+1.	Users can connect to your application using either an email address or a social login option. Upon selecting an option, they will be redirected to a secure login page in the device’s default browser. If the Email option is selected, AppKit will first send an approval link to the user's email, followed by a One-Time Password (OTP) to be used in the login flow. This process helps verify the user’s identity. In both cases, whether using Email or Social login, a non-custodial wallet will be created for the user. This wallet will be accessible across any application that integrates AppKit and Email Wallets.
 
-2. Eventually the user can optionally choose to move from a non-custodial wallet to a self-custodial one by pressing "Upgrade Wallet" on AppKit. This will open the (Reown secure website) that will walk your user through the upgrading process.
-
-<Note>
-Due to Safari’s strict third-party cookie policies, the SDK is not preserving sessions after the app is terminated (removed from memory). So upon app termination the user will have to re-authenticate themselves through a new OTP code if they want to sign. Our team is working to solve this issue soon.
-</Note>
+2.	Eventually, users can optionally choose to upgrade from a non-custodial wallet to a self-custodial one by tapping “Upgrade Wallet” in AppKit. This action opens the Reown secure website, which guides the user through the upgrade process.

appkit/flutter/core/installation.mdx

@@ -9,9 +9,9 @@ Let's get started with the installation and configuration!
 
 ## Installation
 
-<Info>
+<Note>
 If you are just starting a new project, you can use our [CLI tool](https://pub.dev/packages/reown_cli) to get started quickly.
-</Info>
+</Note>
 
 1.  - Add `reown_appkit` as dependency in your `pubspec.yaml` and run `flutter pub get` (check out the [latest version](https://pub.dev/packages/reown_appkit/install))
     - Or simply run `flutter pub add reown_appkit`
@@ -79,8 +79,6 @@ Example:
 </Tab>
 </Tabs>
 
-<hr />
-
 ### Coinbase Wallet support
 
 Coinbase Wallet does not use the WalletConnect protocol for communication between the dApp and the wallet.

appkit/flutter/core/options.mdx

@@ -4,6 +4,7 @@ title: Options
 
 ```javascript
 final _appKitModal = ReownAppKitModal(
+  logLevel: LogLevel.error,
   context: context,
   projectId: '{YOUR_PROJECT_ID}',
   metadata: const PairingMetadata(
@@ -14,7 +15,7 @@ final _appKitModal = ReownAppKitModal(
     redirect: Redirect( // OPTIONAL
       native: 'exampleapp://',
       universal: 'https://reown.com/exampleapp',
-      linkMode: false,
+      linkMode: true|false,
     ),
   ),
   // disconnectOnDispose: false,
@@ -25,12 +26,19 @@ final _appKitModal = ReownAppKitModal(
   //   socials: [...], // OPTIONAL - empty by default
   //   showMainWallets: true, // OPTIONAL - true by default
   // ),
-  // getBalanceFallback: () async { }, OPTIONAL - null by default
-  // requiredNamespaces: {}, OPTIONAL - null by default
-  // optionalNamespaces: {}, OPTIONAL - null by default
-  // featuredWalletIds: {}, OPTIONAL - null by default
-  // includedWalletIds: {}, OPTIONAL - null by default
-  // excludedWalletIds: {}, OPTIONAL - null by default
+  // getBalanceFallback: () async { }, // OPTIONAL - null by default
+  // requiredNamespaces: {}, // OPTIONAL - null by default
+  // optionalNamespaces: {}, // OPTIONAL - null by default
+  // featuredWalletIds: {}, // OPTIONAL - null by default
+  // includedWalletIds: {}, // OPTIONAL - null by default
+  // excludedWalletIds: {}, // OPTIONAL - null by default
+  // customWallets: [ // OPTIONAL - null by default
+  //   ReownAppKitModalWalletInfo(
+  //     listing: AppKitModalWalletListing(
+  //       ...
+  //     ),
+  //   ),
+  // ],
 );
 ```
 
@@ -56,7 +64,7 @@ This callback method will be triggered if getting the balance from our blockchai
 
 These are the set of namespaces that will be requested to the wallet you are connecting to.
 
-These values are optionals and, in most cases, not required since AppKit already defines every required and optional namespace internally based on configured networks.
+These values are optional and, in most cases, not required, as AppKit already defines all required and optional namespaces internally based on the configured networks (EVM and Solana by default).
 
 However, if you would want to override that definition with your own or support more networks than just EVM and Solana (i.e. Polkadot, Kadena, etc...) these are the object you should modify. See [Custom Networks](../core/custom-chains). section.
 
@@ -96,3 +104,27 @@ final Set<String> excludedWalletIds = {
   'fd20dc426fb37566d803205b19bbc1d4096b248ac04548e3cfb6b3a38bd033aa', // Coinbase Wallet
 }
 ```
+
+### customWallets:
+
+A list of user defined wallets. Example:
+
+```javascript
+customWallets: [
+  ReownAppKitModalWalletInfo(
+    listing: AppKitModalWalletListing(
+      id: '00001',
+      name: 'Reown Web Sample',
+      homepage: 'https://react-wallet.walletconnect.com',
+      imageId:
+          'https://avatars.githubusercontent.com/u/179229932?s=200&v=4',
+      order: 1,
+      webappLink: 'https://react-wallet.walletconnect.com',
+    ),
+  ),
+],
+```
+
+### disconnectOnDispose:
+
+Whether if you want to disconnect the user when disposing the context that holds  your modal instance

appkit/flutter/core/usage.mdx

@@ -23,19 +23,32 @@ In order to initialize `ReownAppKitModal()` instance you must provide a _project
 ```javascript
 // AppKit Modal instance
 final _appKitModal = ReownAppKitModal(
+  logLevel: LogLevel.error,
   context: context,
   projectId: '{YOUR_PROJECT_ID}',
   metadata: const PairingMetadata(
     name: 'Example App',
     description: 'Example app description',
     url: 'https://example.com/',
     icons: ['https://example.com/logo.png'],
-    redirect: Redirect(  // OPTIONAL
+    redirect: Redirect(
       native: 'exampleapp://',
       universal: 'https://reown.com/exampleapp',
       linkMode: true|false,
     ),
   ),
+  enableAnalytics: true,
+  siweConfig: SIWEConfig(...),
+  featuresConfig: FeaturesConfig(...),
+  getBalanceFallback: () async {},
+  disconnectOnDispose: true|false,
+  customWallets: [
+    ReownAppKitModalWalletInfo(
+      listing: AppKitModalWalletListing(
+        ...
+      ),
+    ),
+  ],
 );
 
 // Register here the event callbacks on the service you'd like to use. See `Events` section.