@planningcenter/topbar 8.3.1 → 8.3.2-home-team.1

package/README.md

@@ -31,7 +31,7 @@ For a handful of reasons (not least of which is because we pay per Jolt connecti
 **Note that this connection sharing is entirely optional for the parent app, but strongly encouraged.**
 If a Jolt connection is not shared with topbar, it will gladly initiate its own connection specifically for its purposes.
 
-To reuse your app's Jolt connection, topbar requires a Promise that resolves into a [Jolt client](https://github.com/ministrycentered/jolt-client/) connection.
+To reuse your app's Jolt connection, topbar requires a Promise that resolves into a [Jolt client](https://github.com/planningcenter/jolt-client/) connection.
 If nothing is passed—or if a Promise is passed that resolves to `undefined` or `void`—topbar will initiate its own connection.
 
 Topbar hooks into `pco-page-expired` and will `disconnect` when the session is invalidated (i.e. logged out in a different tab).
@@ -114,6 +114,62 @@ If you are passing your own Jolt client object into Topbar via props, you can co
 If you are relying on Topbar to create its own Jolt connection and would like to enable logging, pass `enableJoltLogging={true}` as a prop to whichever topbar
 you are using (`SmallTopbar`/`NotSmallTopbar`).
 
+## Toolbar
+
+Toolbar lives alongside Topbar on the right side of the viewport. It is responsible for the global concerns of Profile, Help Desk, Tasks, Notifications, and Core Messaging.
+
+### Contributing
+
+Tool implementations are self-contained modules that live in the `modules/toolbar/tools/` directory.
+
+A tool module is required to have a named export which adheres to the following `ToolbarTool` interface.
+
+```ts
+interface ToolbarTool {
+  component: unknown // A React component. Stronger typing is in the works.
+  icon: string
+  name: string
+}
+```
+
+- `component`: the React component that will be rendered into the drawer when the tool is selected.
+- `icon`: the name of the [`tapestry-react` icon](https://planningcenter.github.io/tapestry-react/icon#preview-icons) that will be rendered as the button in Toolbar.
+- `name`: the formal name of the tool. For now, this is only surfaced for accessibility concerns on the tool's toolbar `Button`.
+
+### Example
+
+The following example implements an example tool using the shared `DrawerHeader` and `DrawerHeading` components.
+
+- `DrawerHeader` handles the placement and styling of the close button.
+- `DrawerHeading` handles the styling of the drawer heading.
+
+```ts
+// tool_name.tsx
+
+import { DrawerHeader, DrawerHeading } from "../components"
+
+import { ToolbarTool } from "../types"
+
+function ToolComponent({ closeDrawer }) {
+  return (
+    <>
+      <DrawerHeader closeDrawer={closeDrawer}>
+        <DrawerHeading>Tool name</DrawerHeading>
+      </DrawerHeader>
+      {/* Tool drawer content implementation */}
+    </>
+  )
+}
+
+const ToolName: ToolbarTool = {
+  component: ToolComponent,
+  icon: "general.toolbarIconName",
+  name: "Tool name",
+}
+
+export { ToolName }
+```
+
 ## Migrate
 
 These migration docs will guide you thru the process of updating to recent major releases.
@@ -137,13 +193,13 @@ If you like history, here are the initial release notes with technical considera
 
 ## Example product implementations
 
-- [API](https://github.com/ministrycentered/api/blob/master/app/javascript/components/api_topbar.jsx)
-- [Accounts](https://github.com/ministrycentered/accounts/blob/master/app/javascript/components/accounts_topbar.jsx)
-- [Calendar](https://github.com/ministrycentered/resources/blob/master/app/javascript/components/CalendarTopbar.jsx)
-- [Check-Ins](https://github.com/ministrycentered/check-ins/blob/master/app/javascript/components/checkins_topbar.js)
-- [Giving](https://github.com/ministrycentered/giving/blob/master/app/javascript/application/components/giving_topbar.jsx)
-- [Groups](https://github.com/ministrycentered/groups/blob/master/app/javascript/application/components/groups_topbar.js)
-- [People](https://github.com/ministrycentered/people/blob/master/app/javascript/components/people_topbar.jsx)
-- [Publishing](https://github.com/ministrycentered/publishing/blob/master/app/javascript/src/PublishingTopbar.js)
-- [Registrations](https://github.com/ministrycentered/registrations/blob/master/app/javascript/components/registrations_topbar.jsx)
-- [Services](https://github.com/ministrycentered/services/blob/master/app/javascript/components/ServicesTopbar.js)
+- [API](https://github.com/planningcenter/api/blob/master/app/javascript/components/api_topbar.jsx)
+- [Accounts](https://github.com/planningcenter/accounts/blob/master/app/javascript/components/accounts_topbar.jsx)
+- [Calendar](https://github.com/planningcenter/calendar/blob/master/app/javascript/components/CalendarTopbar.jsx)
+- [Check-Ins](https://github.com/planningcenter/check-ins/blob/master/app/javascript/components/checkins_topbar.js)
+- [Giving](https://github.com/planningcenter/giving/blob/master/app/javascript/application/components/giving_topbar.jsx)
+- [Groups](https://github.com/planningcenter/groups/blob/master/app/javascript/application/components/groups_topbar.js)
+- [People](https://github.com/planningcenter/people/blob/master/app/javascript/components/people_topbar.jsx)
+- [Publishing](https://github.com/planningcenter/publishing/blob/master/app/javascript/src/PublishingTopbar.js)
+- [Registrations](https://github.com/planningcenter/registrations/blob/master/app/javascript/components/registrations_topbar.jsx)
+- [Services](https://github.com/planningcenter/services/blob/master/app/javascript/components/ServicesTopbar.js)

package/dist/topbar.css

@@ -1,2 +1,2 @@
-.hide-scrollbar{-ms-overflow-style:none;scrollbar-width:none}.hide-scrollbar::-webkit-scrollbar{display:none}@-webkit-keyframes spinning{to{transform:rotate(1turn)}}@keyframes spinning{to{transform:rotate(1turn)}}.spinner{align-self:center;-webkit-animation:spinning .5s linear infinite;animation:spinning .5s linear infinite;border:2px solid #f7f7f7;border-radius:50%;border-top-color:#9e9e9e;display:inline;height:16px;transform:rotate(0deg);vertical-align:middle;width:16px}
+.hide-scrollbar{-ms-overflow-style:none;scrollbar-width:none}.hide-scrollbar::-webkit-scrollbar{display:none}
 /*# sourceMappingURL=topbar.css.map */

package/dist/topbar.css.map

@@ -1 +1 @@
-{"version":3,"sources":["utils.css","spinner.css"],"names":[],"mappings":"AAAA,gBACE,uBAAwB,CACxB,oBACF,CACA,mCACE,YACF,CCNA,4BACE,GAEE,uBACF,CACF,CACA,oBACE,GAEE,uBACF,CACF,CAEA,SACE,iBAAkB,CAClB,8CAAyC,CAAzC,sCAAyC,CAKzC,wBAAiB,CAHjB,iBAAkB,CAGlB,wBAAiB,CACjB,cAAe,CACf,WAAY,CACZ,sBAAuB,CACvB,qBAAsB,CACtB,UACF","file":"topbar.css","sourcesContent":[".hide-scrollbar {\n  -ms-overflow-style: none; /* IE and Edge */\n  scrollbar-width: none; /* Firefox */\n}\n.hide-scrollbar::-webkit-scrollbar {\n  display: none; /* Chrome, Safari, and Opera */\n}\n","@-webkit-keyframes spinning {\n  100% {\n    -webkit-transform: rotate(360deg);\n    transform: rotate(360deg);\n  }\n}\n@keyframes spinning {\n  100% {\n    -webkit-transform: rotate(360deg);\n    transform: rotate(360deg);\n  }\n}\n\n.spinner {\n  align-self: center;\n  animation: spinning 500ms infinite linear;\n  border-color: hsl(0 0% 97%);\n  border-radius: 50%;\n  border-style: solid;\n  border-top-color: hsl(0 0% 62%);\n  border-width: 2px;\n  display: inline;\n  height: 16px;\n  transform: rotate(0deg);\n  vertical-align: middle;\n  width: 16px;\n}\n"]}
+{"version":3,"sources":["utils.css"],"names":[],"mappings":"AAAA,gBACE,uBAAwB,CACxB,oBACF,CACA,mCACE,YACF","file":"topbar.css","sourcesContent":[".hide-scrollbar {\n  -ms-overflow-style: none; /* IE and Edge */\n  scrollbar-width: none; /* Firefox */\n}\n.hide-scrollbar::-webkit-scrollbar {\n  display: none; /* Chrome, Safari, and Opera */\n}\n"]}