Improve and make consistent chips' data object about materialize

[nicknickel]

This would be a huge win in my opinion. The current data structure requirement for autocomplete and chips is inelegant. I think for right now the goal for this project is to keep things backwards compatible so there might be a bit more logic needed but very worth the improved ease of use this change would bring.

My two cents on the particulars: I think it could be good to have configuration object settings that define the keys the component should use for display and ID. Instead of being forced to using the "tag" key, you could use "value" or "text" or however your data came from the server.

[evansharp]

Thanks for the positive feedback!

I've read the contributing guide a few times, but I'm very inexperienced with writing tests; as in, have only done it a few times for school. I think that is something I'll need help with.

Once I create my own branch for working on this, is it appropriate to share a link to that branch of my fork here so others can help me?

@nicknickel: Would looking for the config object you're suggesting be a good enough compromise on backwards compatibility? i.e. if a config object exits, it gets used, but if not, the v1 implementation is expected? Did you picture it a different way?

[DanielRuf]

I think we already have some breaking changes especially due to the security fixes.

#49

[nicknickel]

@evansharp - That's about what I had in mind. If a key is specified, use that, otherwise use the "tag" key.

[evansharp]

I have created a branch on my own fork for work on this:
https://github.com/evansharp/materialize/tree/chips-data-enhancement

Please ping me for push access to collaborate!

edit: I just noticed in the contribution guide it says to branch master, but I branched from dev-1, is this ok?

[Smankusors]

Please ping me for push access to collaborate!

you can create a new PR to this repo for that 😉

edit: I just noticed in the contribution guide it says to branch master, but I branched from dev-1, is this ok?

I think that's fine, but it will create a new merge commit for that.

I see... you haven't started it yet? Then you can create new branch from master if you want.

[evansharp]

@Smankusors, thank you for patience helping me to learn the workflow here.

you can create a new PR to this repo for that

which repo do you mean by 'this'? Do I not wait to open the PR back to the main project until the pull is ready in my fork?

it will create a new merge commit for that

Do you mean from dev-1 into master in the main project? Does it not work like: I/we code in branch on my fork, PR to get merge into dev branch on main project, then periodic PR from dev into master that captures multiple dev PRs for release?

you haven't started it yet

I'm a high school teacher, I'll be chipping away at this for a bit on weekends; especially with the amount of work I need to do to understand the chips module at my level of JS knowledge. I have a long weekend right now though, so planning to get started.

[Smankusors]

which repo do you mean by 'this'? Do I not wait to open the PR back to the main project until the pull is ready in my fork?

well this I mean materializecss/materialize 😅

Do you mean from dev-1 into master in the main project?

Hmm for now, you should target the PR to v1-dev on this repo.

Does it not work like: I/we code in branch on my fork, PR to get merge into dev branch on main project, then periodic PR from dev into master that captures multiple dev PRs for release?

The devs may or may not do PR for that. They might just do simple merge commit without creating a PR. For this repo though... there's no plan yet.

I'm a high school teacher, I'll be chipping away at this for a bit on weekends; especially with the amount of work I need to do to understand the chips module at my level of JS knowledge. I have a long weekend right now though, so planning to get started.

just take your time. You can create new branch from v1-dev, and then immediately create a PR, but don't forget to mark it as "draft". So other people know that you are currently still working on this. 😉

[DanielRuf]

just take your time. You can create new branch from v1-dev, and then immediately create a PR, but don't forget to mark it as "draft". So other people know that you are currently still working on this. 😉

Exactly.

👍

Great issue description and enhancement. Please let us know if there are additional question or problems so we may help you with the process to create the PR.

[evansharp]

Sorry to do this everyone but it's my first time with a node project of this scale: How do I build with node/grunt after making edits to source files on my fork?

I've installed npm and grunt, I think I've now got grunt installed in the project. The directions for building from a commit are npm run release -- --oldver=<current_version> --newver=<new_version>, but what should those values be if I'm building my fork (chips-data-enhancement)? Or is there another command besides run release that I should use while developing?

Thanks!

[Smankusors]

actually you can just run npm release. It's just the version on the license header comment will be wrong (it will show "vundefined" instead).

[ChildishGiant]

Would this be in our initial release or after, as it'll be a breaking change?

[wuda-io]

I think version 1.1.0 would be a compromise. Or we start from 2.0.0. Cheers

[evansharp]

Would this be in our initial release or after, as it'll be a breaking change?

@ChildishGiant Actually I'm going to write it to be backwards compatible. Read up for the plan.

@Smankusors npm/grunt is being a huge pain. I know this isn't the place to get help setting it up. Would you consider DMing me?

[evansharp]

I don't want this issue to be pruned. I'm still spending time sporadically trying to set up Grunt in my dev env. When I get there I will make a PR to draw attention to my progress.

In the meantime, if anyone feels like helping me (a Node ultranoob) out with the build pipeline, an email or DM woudl be much appreciated.

[Smankusors]

@Smankusors npm/grunt is being a huge pain. I know this isn't the place to get help setting it up. Would you consider DMing me?

ouh sorry for the late reply. About the npm setup, I'm afraid I don't have much time, but I would like to help you as far as I can. What is your current environment? Is it Windows? Mac? Linux?

DM? Do you mean DM on the Twitter?

[evansharp]

Thanks @Smankusors!

DM? Do you mean DM on the Twitter?

I always forget GH has no privatemail. Do you use Discord? I'm theultranoob#2421 there.

What is your current environment?

• MacOS 11.2.3
• node, grunt, etc managed with homebrew
• source is a fork off this repo

The gist of where I'm stuck is that Node and Grunt seem to be installed ok, but...
npm install -g grunt-cli finishes clean
npm install grunt --save-dev in the repo dir finishes clean with 12 vulnerabilities
grunt finishes with

grunt-cli: The grunt command line interface (v1.4.1)

Fatal error: Unable to find local grunt.

If you're seeing this message, grunt hasn't been installed locally to
your project. For more information ...

What am I missing for grunt to be installed locally?

[Smankusors]

Thanks @Smankusors!

DM? Do you mean DM on the Twitter?

I always forget GH has no privatemail. Do you use Discord? I'm theultranoob#2421 there.

What is your current environment?

• MacOS 11.2.3
• node, grunt, etc managed with homebrew
• source is a fork off this repo

The gist of where I'm stuck is that Node and Grunt seem to be installed ok, but...
npm install -g grunt-cli finishes clean
npm install grunt --save-dev in the repo dir finishes clean with 12 vulnerabilities
grunt finishes with

grunt-cli: The grunt command line interface (v1.4.1)

Fatal error: Unable to find local grunt.

If you're seeing this message, grunt hasn't been installed locally to
your project. For more information ...

What am I missing for grunt to be installed locally?

I just sent you friend request from Smankusors#1279 😉

Hmm my dev environment for materializecss is Linux OS though... I'm not sure if the grunt need to be installed globally....

What happen if you run npm run dev? Is it spitting any errors? How about npm test?

[DanielRuf]

Afaik grunt-cli has to be installed globally. And the CLI looks for a local version of grunt. If there is none, it will try the global version (if one is installed, the CLI is standalone and does not include grunt itself).

[LoganTann]

Hello, any updates about this issue ?

[wuda-io]

fixed with #261