Merge remote-tracking branch 'origin/main'

Aleem Mawani · Aleem Mawani · commit b5960300dbf3 · 2022-10-07T20:17:40.000-07:00
diff --git a/docs/butterbar.md b/docs/butterbar.md
@@ -1,5 +1,4 @@
 ---
-id: butterbar
 title: ButterBar
 ---
 This namespace contains methods for showing informative messages to the user. In Gmail this is a small yellow "butter bar" overlay near the top.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,4 @@
 ---
-id: changelog
 title: Change Log
 ---
 
diff --git a/docs/common-data-types.md b/docs/common-data-types.md
@@ -1,5 +1,4 @@
 ---
-id: common-data-types
 title: Common Data Types
 ---
 
diff --git a/docs/compose.md b/docs/compose.md
@@ -1,5 +1,4 @@
 ---
-id: compose
 title: Compose
 ---
 
diff --git a/docs/conversations.md b/docs/conversations.md
@@ -1,5 +1,4 @@
 ---
-id: conversations
 title: Conversations
 ---
 This namespace allows you to interact with Gmail conversations (typically called threads). The fundamental views you interact with are ThreadView and MessageView and there is a 1 to many relationship between them. The functions in Conversations.* allow you to obtain these views which you can then further manipulate.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,7 +1,5 @@
 ---
-id: getting-started
 title: Getting Started
-sidebar_label: Getting Started
 slug: /
 ---
 
@@ -17,13 +15,16 @@ Don't forget to register for an AppId to run your app in production, it's quick
 ## Quick Start
 
 Get your AppId here: [`🌎 AppId Registration`](https://www.inboxsdk.com/register)  
-Download the SDK here: [`⬇️  inboxsdk.js`](https://www.inboxsdk.com/build/inboxsdk.js)
 
-:::tip MV3 Compatible Beta now on NPM
-New beta of `inboxsdk.js` available on NPM that is compatible with Manifest V3 and doesn't use remote loading [See Announcement](https://groups.google.com/g/inboxsdk/c/MAT_zImFu5I/m/N_7nDojRAgAJ)
+:::tip MV3 Compatible Version now on NPM
+The InboxSDK is now available on NPM in a Chrome MV3-compatible form which does not use remote loading. This Getting Started page is still being updated for the NPM version. Please see instead the [Hello World example extension GitHub repo](https://github.com/InboxSDK/hello-world) and the [NPM version announcement post](https://groups.google.com/g/inboxsdk/c/MAT_zImFu5I/m/N_7nDojRAgAJ).
 :::
 
-### Hello World! Sample Extension
+**The instructions below referring to `inboxsdk.js` are currently mostly about the non-NPM Chrome MV2 compatible release that uses remote code loading.**
+
+Download the SDK here: [`⬇️  inboxsdk.js`](https://www.inboxsdk.com/build/inboxsdk.js)
+
+### Hello World! Sample MV2 Extension
 
 Here's how simple it is to build a basic app, you need two files: `myapp.js` which is your application code that interacts with the SDK, and the `manifest.json` which describes a basic Chrome extension.
 
@@ -293,5 +294,6 @@ InboxSDK.load(2, 'YOUR_APP_ID_HERE').then(function(sdk){
   });
 });
 ```
+
 ### Compatibility
 The SDK is currently at version 2 and when loading the SDK that is the number you should specify. The SDK may add backwards compatible API's to the current version, but incompatible changes will come with a version update. Your code is guranteed to work so long as you specify the correct version number AND that version number is at most two releases old.
diff --git a/docs/global.md b/docs/global.md
@@ -1,5 +1,4 @@
 ---
-id: global
 title: Global
 ---
 This namespace contains methods and types related to the UI Elements that are available Globally in Gmail.
diff --git a/docs/inboxsdk-star.md b/docs/inboxsdk-star.md
@@ -1,5 +1,4 @@
 ---
-id: inboxsdk-star
 title: InboxSDK.*
 ---
 
diff --git a/docs/keyboard-shortcuts.md b/docs/keyboard-shortcuts.md
@@ -1,5 +1,4 @@
 ---
-id: keyboard-shortcuts
 title: Keyboard Shortcuts
 ---
 This namespace allows you to setup keyboard shortcuts that your application can response to.
diff --git a/docs/lists.md b/docs/lists.md
@@ -1,5 +1,4 @@
 ---
-id: lists
 title: Lists
 ---
 
diff --git a/docs/navmenu.md b/docs/navmenu.md
@@ -1,6 +1,4 @@
 ---
-## ---
-id: navmenu
 title: NavMenu
 ---
 This namespace contains functionality associated with adding navigation items to the navigation menu of Gmail. Typically, these navigation links are accessible by the user on the left side of the email client and include built in navigation items like the Inbox, Sent Mail or Drafts links.
diff --git a/docs/resources.md b/docs/resources.md
@@ -1,5 +1,4 @@
 ---
-id: resources
 title: Resources
 ---
 
diff --git a/docs/router.md b/docs/router.md
@@ -1,5 +1,4 @@
 ---
-id: router
 title: Router
 ---
 This namespace contains functionality associated with creating your own content inside Gmail. It allows you to define "Routes" which define a full page of content and an associated URL space for which they are active. You can think of routes as different pages in your application. Gmail already have a few routes built in (Inbox, Sent, Drafts, etc). This namespace allows you to define your own as well as listen in on the built in routes being navigated to.
diff --git a/docs/toolbars.md b/docs/toolbars.md
@@ -1,5 +1,4 @@
 ---
-id: toolbars
 title: Toolbars
 ---
 The Toolbar namespace allows you to add your own buttons and actions to various toolbars in Gmail or Inbox. Toolbars appear in various Lists, ThreadViews and MessageViews. Within a toolbar, you have control over the placement of your buttons.
diff --git a/docs/user.md b/docs/user.md
@@ -1,5 +1,4 @@
 ---
-id: user
 title: User
 ---
 This namespace contains methods and types related to the currently logged in user.
diff --git a/docs/widgets.md b/docs/widgets.md
@@ -1,5 +1,4 @@
 ---
-id: widgets
 title: Widgets
 ---
 This namespace contains functions for creating various widgets that are styled to look and feel native to Gmail.
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -12,6 +12,7 @@ module.exports = {
   themeConfig: {
     algolia: {
       apiKey: '319308999ead35d0a17df976af4a951a',
+      appId: 'inboxsdk',
       indexName: 'inboxsdk',
       searchParameters: {}, // Optional (if provided by Algolia)
     },
@@ -24,9 +25,10 @@ module.exports = {
       },
       items: [
         {
-          href: 'https://github.com/InboxSDK/inboxsdk-docs',
-          label: 'Edit on GitHub',
+          href: 'https://github.com/InboxSDK/InboxSDK',
           position: 'right',
+          className: 'header-github-link',
+          'aria-label': 'GitHub repository',
         },
       ],
     },
@@ -57,10 +59,6 @@ module.exports = {
         {
           title: 'Community',
           items: [
-            {
-              label: 'Google Group',
-              href: 'https://groups.google.com/forum/?nomobile=true#!forum/inboxsdk',
-            },
             {
               label: 'Twitter',
               href: 'https://twitter.com/inboxsdk',
diff --git a/package.json b/package.json
@@ -12,12 +12,12 @@
     "clear": "docusaurus clear"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.6",
-    "@docusaurus/preset-classic": "2.0.0-beta.6",
+    "@docusaurus/core": "2.1.0",
+    "@docusaurus/preset-classic": "2.1.0",
     "@mdx-js/react": "^1.6.21",
-    "clsx": "^1.1.1",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "clsx": "^1.2.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "browserslist": {
     "production": [
diff --git a/src/css/custom.css b/src/css/custom.css
@@ -23,3 +23,21 @@
   margin: 0 calc(-1 * var(--ifm-pre-padding));
   padding: 0 var(--ifm-pre-padding);
 }
+
+.header-github-link:hover {
+  opacity: 0.6;
+}
+
+.header-github-link:before {
+  content: '';
+  width: 24px;
+  height: 24px;
+  display: flex;
+  background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
+    no-repeat;
+}
+
+html[data-theme='dark'] .header-github-link:before {
+  background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
+    no-repeat;
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: butterbar`
`3`	`2`	`title: ButterBar`
`4`	`3`	`---`
`5`	`4`	`This namespace contains methods for showing informative messages to the user. In Gmail this is a small yellow "butter bar" overlay near the top.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: changelog`
`3`	`2`	`title: Change Log`
`4`	`3`	`---`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: common-data-types`
`3`	`2`	`title: Common Data Types`
`4`	`3`	`---`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: compose`
`3`	`2`	`title: Compose`
`4`	`3`	`---`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: conversations`
`3`	`2`	`title: Conversations`
`4`	`3`	`---`
`5`	`4`	`This namespace allows you to interact with Gmail conversations (typically called threads). The fundamental views you interact with are ThreadView and MessageView and there is a 1 to many relationship between them. The functions in Conversations.* allow you to obtain these views which you can then further manipulate.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: global`
`3`	`2`	`title: Global`
`4`	`3`	`---`
`5`	`4`	`This namespace contains methods and types related to the UI Elements that are available Globally in Gmail.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: inboxsdk-star`
`3`	`2`	`title: InboxSDK.*`
`4`	`3`	`---`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: keyboard-shortcuts`
`3`	`2`	`title: Keyboard Shortcuts`
`4`	`3`	`---`
`5`	`4`	`This namespace allows you to setup keyboard shortcuts that your application can response to.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`---`
`2`		`-id: lists`
`3`	`2`	`title: Lists`
`4`	`3`	`---`
`5`	`4`