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

Issue: Improve Documentation for TypeScript Projects and Usage Instructions #866

Open
Munna5553 opened this issue Jun 25, 2024 · 1 comment

Comments

@Munna5553
Copy link

The current documentation lacks details on how to use the component with TypeScript projects. Additionally, there are several issues and points of confusion that need to be addressed:

TypeScript Integration:

Please provide detailed instructions on how to integrate this component into a TypeScript project.
Include the necessary prop types and examples in the documentation.
Retrieving Content:

Provide a clear example of how to get the content where the user calls this component.
Ensure that the example includes both the implementation and the expected output.
ReactJS Usage:

The component throws an error if Mantine is not installed in a ReactJS project, but it works without Mantine in a Next.js project. Please clarify the dependencies and provide consistent instructions for both environments.
Styling Issues:

When using the component, the styles are not applied correctly, causing the content to break. Provide troubleshooting steps and examples to ensure that the styles are applied correctly.

Screenshot 2024-06-26 010041

@YousefED
Copy link
Collaborator

Can you share a Stackblitz or github repo that reproduces your issues? Curious to see exactly what you're running into

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

No branches or pull requests

2 participants