Giter Club home page Giter Club logo

figlog's Introduction

FigLog Evolution Tracker Widget for Figma by Nearform_Commerce - We build beautifully designed, solidly engineered, performant digital experiences for humans, just like you.

FigLog Evolution Tracker Widget for Figma

Maintenance Status License

FigLog

FigLog is the easiest and most efficient way to document team decisions and the evolution of your changes in Figma.

Contents

Overview

The FigLog widget works with both Figma and FigJam files and can be used solo or with a team. Simply drag a new FigLog widget to the canvas and get started customizing and adding your updates. New changelogs can be added by any user that has edit access to the file the widget is used in.

We hope FigLog becomes a useful tool for you as a way of documenting the evolution of your work and the decisions and context around those updates.

Features

  • ๐Ÿ•น๏ธ Optional component status, name, description, version, log types, and branding
  • ๐Ÿ‘ซ Multiplayer collaboration with user name and avatar
  • ๐Ÿ—“๏ธ Automatic date handling (including log edits)
  • ๐Ÿ’… 6 status types
  • ๐Ÿท๏ธ 7 log types (New!)
  • ๐Ÿ”— 26 link types (New!)

Usage

Please see the FigLog Community Page.

Contributing

Please see the Contributing guide.

Icons from Lucide.

Maintenance Status

Active: Nearform_Commerce is actively supporting this open source project, and we expect to continue collaborating on it for the foreseeable future. Bug reports, feature requests and pull requests are greatly appreciated and welcome.

figlog's People

Contributors

bryanbraun avatar carbonrobot avatar cpresler avatar ryansrofe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

figlog's Issues

User Submitted: Add formatting options for links, lists, etc. Is this possible?

A user left the following comment about not being able to add links.

Image

I think this user's feedback is more specifically referring to links inside the body of the changelog text itself. I believe there is a limitation here in terms of what is available from the widget API in terms of formatting. To my knowledge they only offer single or multiline input text fields and those fields don't have the option for Rich Text or Markdown etc.

Is there a way around with an additional library or something?

Chore: Update github repo and Figma community page content

We need to update the Figma Community page and the GitHub repo with new copy and graphics.

GitHub Repo

  • update the image at the top to match the image used on the community page (Ryan to provide a new image)
  • assess if any updates are needed to the Overview section
  • update the Features section
    • 7 changelog types (Coming Soon) -> 7 log types (New!)
    • 9 link types (Coming Soon) -> 11 link types (New!)
  • update any copyright dates such as on the license page?
  • add/remove any links or required references for new icon usage

Figma Community Page (Ryan can make the edits, need to prep the content)

  • update the image at the top to the latest community header image
  • open to copy suggestions in the Features section.
    • I feel like instead of a list, we can use h3 headers and supporting text for the specific feature, such as how to add a link, etc
    • 7 changelog types (Coming Soon) -> 7 log types (New!)
    • 9 link types (Coming Soon) -> 11 link types (New!)
  • feedback section content updates
    • any additional branding-related updates from Kat
    • add/remove any links or required references for new icon usage
  • a reminder to update Formidable Figma org content

User Submitted: It would be awesome if changes added to FigLog would trigger a new version in Figma's version history

"Nice! It would be awesome if changes added to FigLog would trigger a new version in Figma's version history. Even better if it could automatically sync up with non-autosave version tags :)"

this comment was left on the Figma community page by Pascal Adriaansen. Pretty useful idea I think.

we need to investigate if we can do this, I think we might be able to.
what happens when a log is updated, can we keep them in sync?

User Submitted: Add ability to lock the widget so that accidental changes can not be made to the specific frame

This comment was left by Andrew Moore on our Figma community page...

"Excellent widget, we love it for our design library change log. I would like to recommend adding the ability to lock the widget so that accidental changes can not be made to the specific frame."

This can easily be done. A few things to note.

  • this could be a feature for the widget owner only, contributors would then either be able to edit or not
  • not sure if this is the right way to go, what if the widget owner is no longer around then the widget could be locked
  • I think having the feature be available to anyone, so at least that person had to, on purpose, make changes is okay
  • maybe reach out to Andrew and see if he wouldn't mind if we asked some questions about his use case to make sure we are hitting the mark?

Changelog: design updated flow for adding/editing a change log

what does a user see right after clicking the "new" button?

date is automatically captured
edited or not is automatically generated

how does a user select or change the type of log (depreciated vs breaking)?
how does a user delete a log?
can/should the user be able to change the date of a log?
should there be a setting for not allowing edits?

there was a point where the fidget completely froze and I had to restart it

"We're loving it, although there was a point where the fidget completely froze and I had to restart it, might want to look into that."

The above comment was left on the Figma community page. I think it would be good to get an engineer to have a look at the code and see if there are any performance tweaks to be made. Otherwise, we can keep an eye on this. I've never had the widget freeze personally, even with having multiple on one page.

We need a way to reproduce to fix.

Feature: multi player collaborators are only able to add, edit, and delete their own entries, original widget owner is admin level and can add, edit, and delete all entries

The Idea
The basic idea behind this feature is for the owner of the widget, the user who added the widget to the file, to have admin-level rights to edit and remove all changelogs and content. Whereas collaborators on the widget will only have access to edit and remove their own changelogs.

Some experimentation has been done already for this. Basically, because of how Figma widgets work ("you touched it last") this might need to be redesigned. It seems we are hitting a ceiling in terms of how multi-player editing works with widgets but maybe there is a creative way around it.

The Blocker
Currently, the widget displays in the state the last collaborator to the widget left it. So in the previous attempt to implement this if user A adds a changelog, then clicks away. User B will see the widget in that very same editable state even though they should not be able to edit. Once User B interacts with the widget, the widget will rerender the state based on User B's credentials. When user A comes back they won't be able to initially edit their previous logs but will be able to edit user B's logs, because they will be seeing the widget as User B left it. This is what I mean by "you touched it last display". Essentially all users see the same view instead of each user seeing a dynamic view based on their difference in state.

More information on how Figma widgets run.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.