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

Feature/document tagify component #10

Open
wants to merge 2 commits into
base: documentation-revision
Choose a base branch
from

Conversation

puckybreg
Copy link

@puckybreg puckybreg commented Jul 26, 2024

Description

  • Took the tagify multi-select and search component used in a project's dashboard. Extracted and documented the component for re-use and learning purposes.

TODO

  • Make a gif of the tagify component in action (or take one from online)

Testing Steps

  • Host the vite docs locally with 'npm run docs:dev'
  • Navigate to the '/examples/tagify-component' page and review the text. Make sure the component sets good patterns for future snippets and is clear in its language.

@puckybreg puckybreg changed the base branch from main to documentation-revision July 26, 2024 20:19
<script setup>
import { useHarnessComposable } from "@rtidatascience/harness-vue";
import { onMounted, watch, ref } from "vue";
import { arraysAreEqual } from "@/utils/util";
Copy link
Author

@puckybreg puckybreg Jul 26, 2024

Choose a reason for hiding this comment

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

This utility function arraysAreEqual is used to prevent the watcher from triggering unnecessary updates to the tagify component. It does this by ensuring that updates only occur when there are actual changes to the harness filter options.

I did not document the exact code for this utility function within the component, but feel that it is a self-explanatory function that doesn't need to be included in this code snippet for the code to be re-usable.

Let me know if you think I should move it into the component itself for reproducibility.

@puckybreg puckybreg marked this pull request as ready for review July 29, 2024 16:05
@puckybreg puckybreg requested a review from hardingalexh July 29, 2024 16:06
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.

1 participant