react-spectrum icon indicating copy to clipboard operation
react-spectrum copied to clipboard

Example for RAC Select with complex items is missing

Open agos opened this issue 1 year ago • 9 comments

🙋 Documentation Request

The documentation of RAC Select component mentions an example with "complex items", but the link points to a section which does not exist.

🧢 Your Company/Team

No response

agos avatar Aug 13 '24 17:08 agos

Thank you for catching this, that link should probably point to https://react-spectrum.adobe.com/react-aria/Select.html#text-slots.

LFDanLu avatar Aug 14 '24 00:08 LFDanLu

Hi @LFDanLu,

I would like to work on this issue. Could you please assign it to me or let me know if there are any specific requirements or guidelines I should follow?

Thank you!

parthsali avatar Aug 20 '24 17:08 parthsali

Ah whoops, I just realized I conflated your comment from the other issue with this one. Definitely feel free to pick up this issue, the line in question that needs to be modified is https://github.com/adobe/react-spectrum/blob/69cc4456cc400bce082e21d1fc5f49359e9161b9/packages/react-aria-components/docs/Select.mdx?plain=1#L1064 and as mentioned above should now point to https://react-spectrum.adobe.com/react-aria/Select.html#text-slots instead. Lemme know if you run into any issues getting the docs to build locally!

LFDanLu avatar Aug 21 '24 00:08 LFDanLu

Hi @LFDanLu,

I’m trying to solve a bug, but I’m encountering an error when running the project locally. Here’s what I did:

Steps I Followed:

  1. Forked the repo.
  2. Cloned it locally with the following command:
    git clone https://github.com/parthsali/react-spectrum
    
  3. Navigated to the project directory:
    cd react-spectrum
    
  4. Installed dependencies:
    yarn install
    
  5. Tried to the documentation:
    yarn start:docs
    

Error:

I’m getting the following error when trying to run the project:

Error

Unfortunately, I'm not able to run it locally due to this error. Could you please help me troubleshoot this?

Thank you!

parthsali avatar Aug 21 '24 09:08 parthsali

Looks like you are on a windows machine? If so, there's a branch that will get you up and running. We're in the middle of reviewing it and should have it merged soon https://github.com/adobe/react-spectrum/pull/6313#issue-2274410623

snowystinger avatar Aug 21 '24 10:08 snowystinger

Thank you for the quick response @snowystinger! Yes, I’m on a Windows machine. I’ll keep an eye out for the branch and try again once it’s merged. If there’s anything else I can help with in the meantime, please let me know!

parthsali avatar Aug 21 '24 12:08 parthsali

you could also base your branch off of that one, then you don't have to wait

snowystinger avatar Aug 21 '24 21:08 snowystinger

@parthsali I've merged in #6313, but that fix was mainly around storybook, didn't think to test the local docs build. Mind giving it a shot? I'll try it tomorrow when I'm back home and have access to my windows machine

EDIT: Yep I got the same error, I'll have to dig into later when I get some time, sorry about that.

LFDanLu avatar Aug 22 '24 21:08 LFDanLu

@LFDanLu Thanks for the update! I synced my repo, pulled the latest changes, and rebuilt the entire project, but I'm still not able to run it due to the same error. Let me know if there's anything else I can do to help troubleshoot this.

parthsali avatar Aug 24 '24 06:08 parthsali