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

Branding updates, asset referencing scheme & Shoelace icons #292

Closed
wants to merge 27 commits into from

Conversation

Shrinks99
Copy link
Member

@Shrinks99 Shrinks99 commented Mar 22, 2024

Fixes #291

Changes

  • Updates ReplayWebpage branding!
    • The new logo and type lockup is now used everywhere the old graphics were used
    • The embed now uses the ReplayWebpage logo!
    • Adds the new logo to README wrapped in an H1 with alt text. This logo will change the text color based on the GitHub light / dark theme the user has selected.
    • Adds new app icons for macOS and Windows
    • Adds new favicons & web manifest app icons
  • Removes fa-icon adds sl-icon
    • Partially addresses Update location bar buttons #237 — That issue should be re-scoped and should cover converting them to Shoelace icon buttons.
    • Removed the few imported bootstrap icons that were used in the embed
    • Changes icons to align with ReplayWebpage 2.0 mockups
    • Moves nav bar icons to align with ReplayWebpage 2.0 mockups
  • Changes how images are imported across the whole app!
    • Importing an SVG or WEBP image will now import it as a path to be used in an <img src=""/> attribute.
    • Mirrors how we do things in Browsertrix! :)
  • Updates text in various places
    • Adheres to new terminology
    • Removes outdated references to WBN archives
  • Unhides the load button on smaller screen sizes
  • Improves navigation at smaller screen sizes
    • Moves main navigation buttons from the dropdown back to the nav bar on mobile
    • Does not add the sidebar back to the main nav bar as this sends the user to the full page non-sidebar version of the navigator and it can be confusing to try and get back to the page you were looking at but have that option be unavailable.

Caveats

  • The logo is no longer animated on loading
    • I would like to address this one later with an SVG animation that only runs when loading actions are taking place to better emphasize when a loading action is occurring
  • The app logo in the top left doesn't collapse to remove the text on mobile
    • Probably not that hard to add a switch between brandLockupColor and rwpLogo but I don't know if we have that available to us in JS? Pls advise <3
  • Doesn't update any of the brand colours outside of logos
    • Would like to standardize with Browsertrix once components get replaced, preferably from a unified design token library of values.
  • Does not link to new docs domain that will be used for ReplayWebpage V2 Documentation Update #250, should be added in a followup PR to dev 2.0 once that's in main

Screenshots!

New VS old mobile menus
Screenshot 2024-04-01 at 5 59 07 PM

App icon on the service worker broken page
Screenshot 2024-04-01 at 4 30 02 PM

App icons in the embed
Screenshot 2024-04-01 at 6 01 01 PM

New macOS app icon!
Screenshot 2024-04-01 at 6 03 24 PM

- Missing 3D manifest icons (WIP!)
Adds ~assets directory, duped the setup in Browsertrix
Mirrors Browsertrix, nearly all of this was copied from there!
- Adds custom app icon library
- Adds the shoelace base path icon library
- Sets up Webpack to copy shoelace assets and custom icon library assets
- Sets up Webpack to import SVGs, WOFF files, TTF files, and WEBP files as paths and not data
  - Breaks everything that currently does this! 🫠
- Replaces almost every instance of font awesome icons in the codebase with shoelace icons (Bootstrap)
- Adds the new brand assets!  Replaces font awesome icons with `img` tags
  - Deletes all the old SVG imports, uses the new ones!
- Removes the SVG loading animation
  - This will return at some point and it will be cool!  I promise!
- Minor nav bar icon grouping changes based on mockups
  - Navigation controls are now all on the left!  Full screen has been moved to the right.
Caveats: Still missing the service worker page
@Shrinks99 Shrinks99 changed the base branch from main to dev-2.0.0 March 22, 2024 05:53
- Changes the theme colour to be flush with the new white application bar
There's no way to actually load new web archives when this is hidden
- Updates help text with usage instructions
- Adds copy button content description
This is used elsewhere, not a 1 line fix.
- Replaces the last `fa-icon` with an image and the new asset linking import
-
- In line with when it shows and hides in the URL bar
- Fixes typo in fullscreen icon button name
@Shrinks99 Shrinks99 marked this pull request as ready for review April 1, 2024 22:04
Keeps bootstrap icons in the embed receipt.
@Shrinks99
Copy link
Member Author

@ikreymer Have reverted to Fontawesome and also updated to Fontawesome v6.

Screenshot 2024-04-04 at 4 21 55 PM

Can't have a double chevron, but this is close enough!
@@ -741,18 +713,15 @@ export class ReplayWebApp extends LitElement {
IS_APP
? html`
<p>
ReplayWeb.page App is a standalone app for Mac,
Windows and Linux that loads web archive files
ReplayWeb.page is a standalone app for Mac,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is less clear, 'archived items' is what we call things in our app, but what we are dealing with is allowing users to load web archive files, which we then refer to as archived items. In general, archived items could be anything, not related to web archives

is a browser-based viewer that loads web archive
files provided by the user and renders them for
replay in the browser.
ReplayWeb.page is a browser-based viewer that loads
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, let's revert this change. The link is useful for opening a link to our site when using the embedded mode.

@Shrinks99
Copy link
Member Author

Closing this PR, making a new one

@Shrinks99 Shrinks99 closed this Apr 5, 2024
@Shrinks99 Shrinks99 mentioned this pull request Apr 5, 2024
@Shrinks99 Shrinks99 deleted the branding-updates branch April 10, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants