@planningcenter/topbar 8.0.0-alpha.1 → 8.0.0

package/CHANGELOG-pre-4.9.0.md

@@ -0,0 +1,134 @@
+# LOST ENTRIES
+
+# 3.0.0 Release
+
+### Squircle Icons
+
+![squircles in the app menu](./docs/images/2018.04.26-v3-desktop-screenshot.png)
+
+You've seen them in Slack.
+Now you can experience them in your own apps.
+
+SQUIRCLES!
+
+### Support for Church Center and API
+
+Some of our products can't be found in Topbar's app-switcher.
+v3 adds support for those non-navigable apps.
+Now, these apps can use Topbar **and** keep out of the app-switcher.
+
+### Support for React 16
+
+@glosie gets the badge for first app to React 16.
+He also gets a badge for updating Topbar's dependencies, allowing you to upgrade to React 16 too!
+
+🤗
+
+### Various UX fixes
+
+v3 resolves a [long-stading useability bug](https://trello.com/c/PQtq5w1u/2568-%F0%9F%90%9E-previously-logged-in-users-linked-accounts-are-visible-for-a-split-second#) where users could (for a split second) see the `connected_people` from the previous session.
+
+Thanks @mcfadden and @ClaytonRector for surfacing that.
+
+## Upgrade from v2
+
+This should be a mostly painless upgrade.
+Here are the APIs that changed and how to update.
+
+### `PlatformAnnouncements`
+
+Platform Announcements were a quickly concieved feature.
+The v2 API has a very "build-your-own" feel.
+After implementing them across apps, we have a better understanding of what they are and how they should be used.
+
+Now I expose a single component for platform announcements.
+
+```jsx
+import { PlatformAnnouncements } from "@planningcenter/topbar";
+```
+
+Implemented it in your `{App}Topbar` like so:
+
+```jsx
+<PlatformAnnouncement
+  data={this.props.platformAnnouncements}
+  colors={shared.colors}
+  env={shared.env}
+/>
+```
+
+#### Naming problems
+
+> Didn't these used to `PlatformNotifications`?
+
+Yes 😬
+
+There are a lot of `notification` features in the pipeline.
+To distinguish these in Topbar-land, we've written up a [dictionary of terms](https://planningcenter.design/interfaces-and-interactions/announcements-and-notifications-and-alerts-oh-my).
+
+I know that this introduces some cognitive dissonence—now that Topbar uses `PlatformAnnouncements` but `platform_notifications` is used for all the #platform tooling.
+
+I'm sorry.
+
+I knew there was eventually naming problem
+but I didn't have a comprehensive solution before the feature needed to ship.
+You only know what you know when you know it.
+
+If you find this dissonence problematic, you can assign on import.
+
+```js
+import { PlatformAnnouncements as PlatformNotifications } from "@planningcenter/topbar";
+```
+
+The props for this componenent are intentionnaly generic (`data`, `renderItem`) to be clear, when referenced by either name.
+
+### `AppsProvider` and `ConnectedPeopleProvider`
+
+These two data-fetching, provider components have new callback signatures.
+
+In adding a `clearCache` method to both, I made the decision to pass objects down instead of functions.
+This allows me to add functionality without changing function arity.
+
+Your use of these components should now look like this:
+
+```jsx
+<ConnectedPeopleProvider
+  render={(connectedPeople, connectedPeopleActions) => (
+    <AppsProvider
+      render={(apps, appsActions) => (
+        /*
+         * connectedPeople
+         * connectedPeopleActions.fetch()
+         * connectedPeopleActions.remove()
+         *
+         * apps
+         * appsActions.fetch()
+         * appsActions.remove()
+         */
+      )}
+    />
+  )}
+/>
+```
+
+### `SmallTopbar` and `NotSmallTopbar`
+
+To support the removal of cached `localStorage` data, both Topbars take an additional required props: `requestClearAppsCache` and `requestClearConnectedPeopleCache`.
+
+In practice these callbacks should be provided from `ConnectedPeopleProvider` and `AppsProvider` like so:
+
+```jsx
+<ConnectedPeopleProvider
+  render={(connectedPeople, connectedPeopleActions) => (
+    <AppsProvider
+      render={(apps, appsActions) => (
+        <SmallTopbar
+          requestClearConnectedPeopleCache={connectedPeopleActions.remove}
+          requestClearAppsCache={appsActions.remove}
+          {...allTheOtherProps}
+        />
+      )}
+    />
+  )}
+/>
+```

package/CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased notifications]
+## [8.0.0] - 2021-03-24
 
 ### Added
 
@@ -113,7 +113,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Versions entries to this changelog weren't tracked very well and were presented in a less organized style (more like a README or upgrade guide). If you are interested in that, you can read about the changes in [README-pre-4.9.0].
 
-[unreleased notifications]: https://github.com/ministrycentered/topbar/compare/@planningcenter/topbar@7.2.1..notifications
+[8.0.0]: https://github.com/ministrycentered/topbar/compare/@planningcenter/topbar@7.2.1..8.0.0
 [7.2.1]: https://github.com/ministrycentered/topbar/compare/v7.2.0..v7.2.1
 [7.2.0]: https://github.com/ministrycentered/topbar/compare/v7.1.3..v7.2.0
 [7.1.3]: https://github.com/ministrycentered/topbar/compare/v7.1.2..v7.1.3

package/README.md

@@ -85,6 +85,19 @@ The `dev` script starts a server at [http://localhost:9000](http://localhost:900
 
 The [`dev/dev.tsx`](./dev/dev.tsx) is the main dev environment component.
 
+### Local App Development
+
+If you are working on a new feature or run into a specific bug in your application and need to inspect the problem locally before publishing, you can use [`yalc`](https://github.com/whitecolor/yalc#yalc) to install and run the Topbar package locally.
+
+To get started:
+
+1. In `/topbar`: `yalc publish`
+2. In your product: `yalc add @planningcenter/topbar`
+
+When you make `topbar` changes, run `yalc publish --push` to update your product.
+
+When you're done, in your product directory run `yalc remove @planningcenter/topbar`.
+
 ## Migrate
 
 These migration docs will guide you thru the process of updating to recent major releases.