untemps/svelte-palette

Svelte component to display a customisable color picker

svelte-palette's Issues

Customization of the number of columns

Add a way to set the number of columns to display in the palette.

Feature Request: Name color slots

Colors are currently defined with a hexa-string through the colors prop.
For some specific use cases, it might be useful to assign a name to each color slot.

For the technical part, this means that the colors props should change to accept an array of colors as an object:

[
   { name: 'Foo', value: '#ff0000' },
   { name: 'Bar', value: '#ff0000' },
   { name: 'Gag', value: '#ff0000' }
]

For some backward compatibility purposes, the legacy color format should still be supported.

In addition, when using the color input, a new field should allow to name the new color.

The color name must be exposed by the color slot slot API to be used for customization.

Issues to address:

• Duplication: Can two colors be named the same?

Compacted view of the palette

Add a way to toggle from the original palette to a compacted version with a restricted selection of colors and minimal spaces.
Th API should allow to choose the colors that are part of the compacted palette.
No clue where to embed the toggling control. May be at the very first position of the slot list or into the footer.

Slots don't get any values

Current component values are not fully passed to slots. That means we cannot use them in custom renderings.

Slot List:

• header : selectedColor
• header-divider : none
• footer : selectedColor
• footer-divider : none
• slot : color, selectedColor, transition, isCompact
• transparent-slot : none
• input : selectedColor, inputType

We may take advantage of this issue to do few more things:

• Add a slot for the compact toggle button
• Prevent from displaying the header in compact mode

Delete slots by index instead of color value

Slots are currently deleted checking the value of the selected slot. That means if several slots have the same value, each of them is removed.
Instead it would be better to reference slots by color and delete the slot a the selected index only.

SyntaxError: Named export 'extractByIndices' not found. The requested module '@untemps/utils/array/extractByIndices' is a CommonJS module, which may not support all module.exports as named exports.

Hi Vincent,

Thanks for the great lib, it saved me a few days of work.

I have this error when automatically deploying on Vercel (through git push). I don't have issues when compiling locally, I'm not sure about the cause of it as I can't reproduce it, and I can't access the generated files by Vercel. So I thought, you might have some ideas:

import { extractByIndices } from "@untemps/utils/array/extractByIndices";
^^^^^^^^^^^^^^^^
SyntaxError: Named export 'extractByIndices' not found. The requested module '@untemps/utils/array/extractByIndices' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export, for example using:

import pkg from '@untemps/utils/array/extractByIndices';
const { extractByIndices } = pkg;

at ModuleJob._instantiate (node:internal/modules/esm/module_job:124:21)
at async ModuleJob.run (node:internal/modules/esm/module_job:190:5)

Implement drag and drop out to delete a color slot

It might be convenient to implement an alternative way to delete a color slot.
The palette displays a tooltip on slot hover when allowDeletion is set to true so far. However, we may propose a deletionMode prop, with two values: tooltip and drop, in replacement of allowDeletion, which, when set, allows to delete a slot the way we defined it.

API proposal:

`deletionMode`: "tooltip" | "drop" | "none" (default)

Feature Request: Typescript Support

Need declaration file for types

Could not find a declaration file for module '@untemps/svelte-palette'. 'C:/drewbitt/GitHub/project/node_modules/.pnpm/@[email protected]/node_modules/@untemps/svelte-palette/dist/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/untemps__svelte-palette` if it exists or add a new declaration (.d.ts) file containing `declare module '@untemps/svelte-palette';`ts(7016)

Feature Request: Allow to customize features

Add a settings section to customize the kind of features we went for the palette.
We may embed some of the configuration parameters we've got in the demo app :

• Color Preselection
• Input Type
• Number of Columns
• Maximum Number of Colors
• Duplicates Permission
• Deletion Mode
• Transparent Slot Display
• Compact Mode Display

The access to the settings section may be set behind a prop flag showSettings

Feature Request: Add a way to limit the number of columns

For some use cases, it would be nice to set a prop limiting the number of columns to be displayed.
This would be applicable when numColumns is lower or equal to 0 only, because, in this case, adding a slot of color always creates a new column. If maxColumns is set, slots would wrap on an additional row when the limit is reached.

Change background color of the component

Hey im trying to use this for my project but i cant figure out how to change the background color of the component any help?

Implement EyeDropper API

The JS EyeDropper API is still experimental yet available on some browsers (Chrome, Edge and Opera).
We should propose a new button to open an EyeDropper and allow the user to select a color. This color would be inserted in the input. The user then would have to click the Add button to create a new slot in the palette.
If the API is not available, the button would not be displayed.

As the input is involved in the process, we should add the EyeDropper button inside the PaletteInput component. Embedding the button in a PaletteEyeDropper component and exporting it would allow to use it without the input.

API PaletteEyeDropper component proposal:

• add: (color) => {} Event dispatched when a color is selected
• buttonAriaLabel: string Aria label of the button

Upgrade Node version for GitHub Actions

GitHub Actions runs deprecated packages as they're based on Node 16 which is deprecated itself:

• actions/checkout
• actions/setup-node
• codecov/codecov-action

We should upgrade those packages to the last version (v4 for all).

Replace util function by @untemps/utils

The component uses a internal util function to resolve classnames based on condition checks.
The @untemps/utils package contains such a function. We can replace the internal one by the one included in the external package.

In dev mode, if preselect is updated to false then the selection does not work as expected

To reproduce:
In dev mode, uncheck the Preselect color option. If displayed, the empty slot should be selected.
Then click a slot. The slot should not be selected. Click it one more time, it should work.

Feature Request: Add a way to manage groups of colors

Sometimes, it would be useful to split the slots of colors into groups, to create collections for instance.
The colors prop could be set with an array of specific object, like so:

const colors = [
  { name: 'Yellows', colors: ['#ff0', '#0f0', '#0ff'] }
]

Expected issues:

• The compactColorIndices is not relevant for groups of colors: what indices of are they?
• It might be difficult to mix single colors and group of colors: a choice in the API has to be made, to restrict to one type of entry for example

Remove duplicated color slots if allowDuplicates is updated to false

When containing several slots with the same color and updating the allowDuplicates prop to false, duplicated slots are preserved.
We should remove them to be consistent.

Replace internal tooltip by @untemps/svelte-use-tooltip

Support Svelte 4

Hello, can you update the dependencies to use Svelte 4 please.
Thanks

Expose an inputType prop to set the type of input "text" or "color"

We may propose a new prop to the Palette and PaletteInput components : inputType with two values text or color.
The value of the prop would be directly passed down to the HTML input component.

We may have to amend the style of the input depending of the value.
We may also hide the slot on the left side of the input if inputType === 'color' since in most browsers the selected color is displayed within the input.
The eyedropper tool may be hidden as well.

Customization of the slot appearance animation

Add a way to define the animation to apply when slots are rendered into the DOM.

Component is not compatible with SvelteKit

Seems like the exported bundle does not allowed to use the lib into a SvelteKit application.

Deletion tooltip still displayed when updating tooltip class name and deletion enabling together

To reproduce:
Instantiate the component with allowDeletion: true and contentClassName: null. The deletion tooltip should be displayed when hovering a slot.
Then update the component with contentClassName: [custom class] and allowDeletion: false (in that order). The tooltip should be displaed when hovering a slot as well even though it should not be.