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

Add a Hero Component to Auraui #3

Open
Jayjeet1013 opened this issue Aug 20, 2024 · 0 comments
Open

Add a Hero Component to Auraui #3

Jayjeet1013 opened this issue Aug 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Jayjeet1013
Copy link
Collaborator

Jayjeet1013 commented Aug 20, 2024

We need to add a responsive, customizable Hero component to the Auraui library. This component will serve as a key element for showcasing primary content, calls to action, or important announcements.

Requirements:

  1. Hero Section:

a. A visually appealing hero section to highlight key content.
b. The component should include:

  • Background image or color options.
  • Headline and subheadline text areas.
  • Call-to-action buttons (with customizable text, size, and colors).
  • Optional support for small descriptions or taglines.
    c. Ensure flexibility in the layout to accommodate variations (centered text, left-aligned, etc.).
  1. Responsiveness:

a. Fully responsive and optimized for all screen sizes (mobile, tablet, desktop).
b. Background image should scale properly across devices.
c. Ensure text, buttons, and other content remain legible and well-placed on small screens.

  1. Customization:

a. Props for customizing:
b. Background (image, color).
c. Text alignment (left, center, right).
d. Button styles and actions.
e. Provide flexible options for changing font sizes, colors, and button layouts.

  1. Performance:

a. Optimize the component for fast loading, ensuring that background images (if any) load efficiently without delaying the rest of the page.
b. Use lazy loading for images to ensure performance isn't hindered on slower networks.

  1. Accessibility:

a. Ensure that the component is fully accessible with screen readers.
b. Use appropriate aria-labels and other accessibility features where necessary.

  1. Implementation:

a. Should be written in a way that works seamlessly with both JavaScript and TypeScript.
b. Follow best practices to align with Auraui’s existing design system.

This Hero component will serve as a foundational section for many webpages and will enhance the flexibility and appeal of the Auraui component library.

Screenshot from 2024-09-11 16-23-04

@Jayjeet1013 Jayjeet1013 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 11, 2024
@Jayjeet1013 Jayjeet1013 changed the title Add Hero Components Add a Hero Component to Auraui Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant