ttebify / content-caddy Goto Github PK

Describe the bug

Currently, the tooltip appears when the user hovers over text inputs. This is not useful for the user, as the extension is designed to save web content for future use. Disabling the tooltip on text inputs would make the user interface more intuitive and less distracting.

To Reproduce

1. Install the Content Caddy extension in your browser.
2. Visit any website that has a text input field.
3. Type in some text into the input field and highlight
4. Observe that the tooltip appears, which is not the intended behaviour.

Expected behaviour
The tooltip should not appear on text inputs

Steps to see it:

1. Load the extension on your browser
2. Click on the Content Caddy extension icon in the browser toolbar to open the popup
3. Click on the "Settings" tab in the popup

Features

1. Write the logic for handling the "Temporarily disable extension" checkbox, "Add quote to text" checkbox, and "Add" button.
2. Make sure that all input fields are properly validated and display an error message if any field is left blank or has invalid input.
3. Test the UI thoroughly to ensure that all functionality is working as expected.

Is your feature request related to a problem? Please describe.

The current implementation of the inputDetector API works well for a few websites, but there are still many more websites out there that may have bugs that prevent the tooltip from working correctly. To improve this, we need to add more website structures and input field selectors to the API.

To do this, we can follow the steps below:

1. Open the Tooltip.tsx file.
2. Locate the handleSelection function.
3. Uncomment the console.log(isTextInput, activeElement) line.
4. Open the website in the browser and copy the HTML element shown in the console log.
5. Inspect the copied element for common classnames, attributes, selectors, etc.
6. Add the new website structure and input field selectors to the websitesInputFieldConfigOptions array in src/config/input_field_configs.ts file.
7. Test the new configuration by using the website and checking if the tooltip works correctly.
8. If the tooltip doesn't work as expected, adjust the threshold value (between 0 and 1) to a suitable value, typically between 0.4 to 0.5.

This is an example for twitter:

export const websitesInputFieldConfigOptions: WebsiteDetectionOptions[] = [
  // Twitter
  {
    href: /twitter\.com\/compose\/tweet/,
    classNames: ["public-DraftEditor-content"],
    selectors: [
      "[data-testid='tweetTextarea_0']",
      "[role='textbox']",
      "[aria-multiline='true']",
      "[contenteditable='true']",
    ],
    attributes: ["spellcheck"],
    threshold: 0.5,
  },
];

We encourage developers to contribute to this effort by adding new website structures and input field selectors to the API. By doing this, we can make the inputDetector API more robust and cover a wider range of websites.

Thank you 🙏 🤩

The current UI for the extension's popup could be improved to make it more user-friendly and intuitive. This issue will focus on improving the design and layout of the popup to make it easier for users to understand and navigate.

Users currently do not have the ability to tag or categorise their saved content. This can make it difficult to find specific content later on. Adding the ability to tag and categorise content would make it easier for users to organise their saved content and find it later.

Possible approach:

1. Open the popup
2. Go to bookmarks
3. Create new tags
4. Assign tags/categories to saved bookmarks

Is your feature request related to a problem? Please describe.

Currently, users have to manually search for the meaning of a word or phrase when they come across it while reading on a website. This can be time-consuming and disrupts the reading experience. It would be helpful to have a feature where users can simply highlight the text and get an explanation of its meaning without leaving the page.

Describe the solution you'd like

I would like a feature where users can highlight a word or phrase and get an explanation of its meaning in a tooltip just under the social button in current tooltip. This tooltip should appear when the user highlights the text, and clicks on an explain icon and should include a brief definition or explanation of the word or phrase. To make this feature more powerful, we could use OpenAI to provide more accurate and detailed explanations.

Collaboration on this feature is open to anyone interested. You can get in touch with me through this platform, or feel free to send me an email or connect with me on Twitter.

Currently, there is a bug where the formatting of copied content is not being preserved. This includes line breaks, which can result in the content being difficult to read. This issue should be fixed to ensure that the copied content retains its original formatting.

Is your feature request related to a problem? Please describe.

Currently, when a new version of the Content Caddy extension is released and users update to it, their settings from the previous version are cleared. This can be frustrating for users who have spent time customising their settings to their preferences. We need to ensure that when new versions of the extension are released, user settings are preserved and not cleared.

Describe the solution you'd like
When a new version of the Content Caddy extension is released, the update process should detect if the user has any existing settings and preserve them. The new version should add any new features and functionality without overriding the existing settings. This will ensure a smoother user experience and avoid frustration caused by lost settings.

Describe the bug
Currently we have the sass plugin added as one of the project deps.

To Reproduce
Steps to reproduce the behaviour:

1. Go to 'package.json'
2. Scroll down to 'devDependencies'
3. See "sass": "1.55.0",

Expected behavior
Remove it by running yarn remove sass

Update the extension's README.md file to include a section giving credit to the source of all icons used in the extension. Icons were obtained from icons8.com.

Is your feature request related to a problem? Please describe.

As the number of saved content items grows, it becomes increasingly difficult for users to find specific items quickly. To improve the user experience, we should add a search feature to the saved content section.

Describe the solution you'd like

Integrate a search bar at the top of the saved content section where users can type in keywords to search for specific items. The search should look through the title and body of the saved content items, and filter out items that don't match the user's query.

• A search bar is added to the top of the saved content section
• The search feature filters saved content items based on keywords in the title and body
• The search feature updates in real-time as the user types in the search bar
• The search feature is easily accessible and intuitive to use for all users

Is your feature request related to a problem? Please describe.
Currently, the Content Caddy extension on the Microsoft web store has a plain design with no cover image or branding. We would like to improve the branding of the extension to make it stand out more.

Visit the extension page on the Microsoft web-store here: https://microsoftedge.microsoft.com/addons/detail/icblaofpjceadeagkejnojmknpbkhpdd.

Describe the solution you'd like
We are seeking assistance from anyone who is willing to help us with this challenge. We would like someone to create a new logo, choose branding colours, and design images that will make the extension more visually appealing and recognisable. Thank you! 🤩

The current extension includes a profile picture and link to contact the developer. This is not necessary and can be replaced with a link to the project's GitHub page. This issue will focus on removing the contact developer profile picture and updating the link to the GitHub page.