Skip to content

Commit 0a77376

Browse files
committed
Updated README.md file.
1 parent 75de792 commit 0a77376

File tree

1 file changed

+93
-70
lines changed

1 file changed

+93
-70
lines changed

README.md

Lines changed: 93 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -89,33 +89,33 @@ ZephyrJS comes with several pre-built components:
8989
Customize components using CSS variables:
9090

9191
```css
92-
:root {
92+
[data-theme="custom"] {
9393
/* Main palette colors */
94-
--primary-color: #5D4E60; /* Muted dark purple */
95-
--secondary-color: #826C7F; /* Muted medium purple */
96-
--accent-color: #A88FAC; /* Soft purple */
97-
--background-color: #F4F7F9; /* Very light blue-gray */
98-
--neutral-color: #D4B2D8; /* Light grayish purple */
99-
--secondary-color-light: #e0e1ff; /* Light shade of secondary color */
94+
--primary-color: #2C2C2C; /* Dark gray */
95+
--secondary-color: #4B0000; /* Dark red */
96+
--accent-color: #FF4500; /* Bright orange-red */
97+
--background-color: #1A1A1A; /* Almost black */
98+
--neutral-color: #808080; /* Medium gray */
99+
--secondary-color-light: #8B0000; /* Dark red */
100100

101101
/* Semantic colors */
102-
--info-color: #17a2b8; /* Standard blue for info */
103-
--info-background: #d1ecf1; /* Light blue for info background */
104-
--success-color: #2ECC71; /* Soft green */
105-
--success-background: #d4edda; /* Light green for success background */
106-
--danger-color: #E74C3C; /* Soft red */
107-
--danger-background: #f8d7da; /* Light red for danger background */
108-
--warning-color: #F39C12; /* Amber */
109-
--warning-background: #fff3cd; /* Light amber for warning background */
102+
--info-color: #FF6347; /* Tomato */
103+
--info-background: #FFE4E1; /* Light red */
104+
--success-color: #32CD32; /* Lime green */
105+
--success-background: #F0FFF0; /* Honeydew */
106+
--danger-color: #DC143C; /* Crimson */
107+
--danger-background: #FFE4E1; /* Light red */
108+
--warning-color: #FFD700; /* Gold */
109+
--warning-background: #FFF8DC; /* Light yellow */
110110

111111
/* Text colors */
112-
--light-text: var(--white); /* White for text on dark backgrounds */
113-
--dark-text: #2C3E50; /* Dark blue-gray for main text */
112+
--light-text: #FFFFFF; /* White */
113+
--dark-text: #FF4500; /* Bright orange-red */
114114

115115
/* Component-specific colors */
116-
--button-hover-bg: #2980B9; /* Darker blue for button hover */
117-
--input-focus-border: #826C7F; /* Adjusted to match the secondary color */
118-
--button-click-bg: #1190B9;
116+
--button-hover-bg: #CD5C5C; /* Indian red */
117+
--input-focus-border: #FF4500; /* Adjusted to match the accent color */
118+
--button-click-bg: #B22222; /* Firebrick */
119119

120120
/* Typography */
121121
--font-family-sans-serif: "Montserrat", "Helvetica Neue", Arial, sans-serif;
@@ -124,12 +124,12 @@ Customize components using CSS variables:
124124

125125
/* Body styles */
126126
--body-bg: var(--background-color);
127-
--body-color: #2C3E50; /* Dark blue-gray for main text */
127+
--body-color: #FF4500; /* Bright orange-red for main text */
128128

129129
/* Link styles */
130130
--link-color: var(--accent-color);
131131
--link-decoration: none;
132-
--link-hover-color: #d54644; /* Darker shade of coral for hover */
132+
--link-hover-color: #FF6347; /* Tomato */
133133

134134
/* Additional theme-specific variables */
135135
--header-bg: var(--primary-color);
@@ -138,7 +138,7 @@ Customize components using CSS variables:
138138
--footer-color: var(--primary-color);
139139
--button-primary-bg: var(--accent-color);
140140
--button-primary-color: white;
141-
--card-bg: white;
141+
--card-bg: #2C2C2C; /* Dark gray for card background */
142142
--card-border: var(--neutral-color);
143143

144144
/* Button specific variables */
@@ -156,22 +156,30 @@ Customize components using CSS variables:
156156
--card-header-margin-bottom: 12px;
157157
--card-content-margin-top: 8px;
158158

159+
/* CardGroup Component Variables */
160+
--card-group-gap: 1rem;
161+
--card-min-width: 250px;
162+
--card-border-color: #808080;
163+
--card-header-color: #FF4500;
164+
--card-content-color: #CD5C5C; /* Indian red */
165+
--card-content-font-size: 1rem;
166+
159167
/* Input specific variables */
160168
--input-margin: 10px 0;
161169
--input-padding: 10px;
162170
--input-border: 1px solid var(--neutral-color);
163171
--input-border-radius: 4px;
164172
--input-font-size: 1rem;
165-
--input-focus-border-color: var(--secondary-color);
173+
--input-focus-border-color: var(--accent-color);
166174

167175
/* Dropdown specific variables */
168176
--dropdown-padding: 10px;
169177
--dropdown-border: 1px solid var(--neutral-color);
170178
--dropdown-border-radius: 4px;
171179
--dropdown-font-size: 1rem;
172180
--dropdown-background: var(--background-color);
173-
--dropdown-arrow: url('data:image/svg+xml;utf8,<svg viewBox="0 0 140 140" xmlns="http://www.w3.org/2000/svg"><polygon points="0,0 140,0 70,70" style="fill:%232A4858;"/></svg>');
174-
--dropdown-focus-border-color: var(--secondary-color);
181+
--dropdown-arrow: url('data:image/svg+xml;utf8,<svg viewBox="0 0 140 140" xmlns="http://www.w3.org/2000/svg"><polygon points="0,0 140,0 70,70" style="fill:%23808080;"/></svg>');
182+
--dropdown-focus-border-color: var(--accent-color);
175183

176184
/* Modal specific variables */
177185
--modal-background: var(--background-color);
@@ -190,7 +198,7 @@ Customize components using CSS variables:
190198

191199
/* Notification specific variables */
192200
--notification-padding: 16px;
193-
--notification-background: var(--light-text);
201+
--notification-background: var(--dark-text);
194202
--notification-border-color: var(--primary-color);
195203
--notification-font-size: 1em;
196204
--notification-success-background: var(--success-background);
@@ -201,21 +209,21 @@ Customize components using CSS variables:
201209
--notification-warning-text: var(--warning-color);
202210

203211
/* Markdown Editor and Renderer Colors */
204-
--markdown-bg: #272822;
205-
--markdown-color: #F8F8F2;
206-
--markdown-keyword: #F92672;
207-
--markdown-string: #E6DB74;
208-
--markdown-number: #AE81FF;
209-
--markdown-function: #A6E22E;
212+
--markdown-bg: #2C2C2C;
213+
--markdown-color: #FF4500;
214+
--markdown-keyword: #DC143C;
215+
--markdown-string: #32CD32;
216+
--markdown-number: #FFD700;
217+
--markdown-function: #FF6347;
210218
--markdown-comment: #75715E;
211-
--markdown-method: #66D9EF;
212-
--markdown-tag: #0000FF;
213-
--markdown-attribute: #FF0000;
219+
--markdown-method: #FF4500;
220+
--markdown-tag: #4B0000;
221+
--markdown-attribute: #FF6347;
214222
--markdown-at-rule: #AF00DB;
215223
--markdown-punctuation: #000000;
216-
--markdown-property: #FF0000;
217-
--markdown-value: #0000FF;
218-
--markdown-selector: #800000;
224+
--markdown-property: #FF6347;
225+
--markdown-value: #4B0000;
226+
--markdown-selector: #FF4500;
219227
--markdown-indentation: #CCCCCC;
220228
--markdown-text: var(--markdown-indentation);
221229

@@ -224,11 +232,12 @@ Customize components using CSS variables:
224232
--spacing-small: 10px;
225233
--spacing-medium: 16px;
226234
--spacing-large: 20px;
235+
227236
--border-radius: 5px;
228237
}
229238
```
230239

231-
You can create your own variables.css to change the values to what suits your project over the defaults.
240+
You can create your own theme to change the values to what suits your project over the defaults.
232241

233242
### License
234243
ZephyrJS is MIT licensed.
@@ -239,33 +248,47 @@ For support, please open an issue on our GitHub repository.
239248
Built with ❤️
240249

241250
### ToDO:
242-
- Carousel: A component for creating image or content sliders, commonly used for showcasing multiple items in a slideshow format.
243-
- Progress Bar: A component to visually indicate the progress of a task or process.
244-
- Spinner/Loader: A component to indicate loading states or background processing.
245-
- Alert: A component for displaying contextual feedback messages, such as warnings, errors, or success messages.
246-
- Breadcrumbs: A component to display the navigation path and help users understand their location within a web application.
247-
- Search Component: A component for searching through data that exists in a Data Table or Tree Table to navigate to the specified item.
248-
- Form: A component for creating and managing user input forms, including validation and submission handling.
249-
- Datepicker: A component for selecting dates from a calendar interface.
250-
- Timepicker: A component for selecting times, often used alongside a datepicker.
251-
- Slider/Range Input: A component for selecting a value or range of values from a predefined range.
252-
- Tree View: A component for displaying hierarchical data in a tree structure, allowing for expanding and collapsing of nodes.
253-
- File Upload: A component for handling file uploads, including drag-and-drop support and progress indicators.
254-
- Menu: A component for creating dropdown or context menus for additional actions or navigation options.
255-
- Modal Form: A modal dialog specifically designed to handle form inputs and submissions within a modal context.
256-
- Stepper: A component to guide users through a multi-step process, often used for forms or workflows.
257-
- Snackbar/Toast: A component for displaying brief messages at the bottom or top of the screen, typically for non-intrusive notifications.
258-
- Rich Text Editor: A component that provides WYSIWYG (What You See Is What You Get) editing capabilities, allowing users to format text with various styles, links, and media.
259-
- Chart/Graph: A component for rendering different types of charts and graphs (e.g., bar, line, pie) using a library like Chart.js or D3.js.
260-
- Split Pane: A component for creating resizable split views, allowing users to adjust the size of adjacent content areas.
261-
- Infinite Scroll: A component for loading content dynamically as the user scrolls, often used in social media feeds or long lists.
262-
- Color Picker: A component for selecting colors, often used in design and customization tools.
263-
- Stepper Wizard: A more advanced stepper component that guides users through multi-step processes, with validation and navigation controls.
264-
- Image Gallery: A component for displaying image collections with features like lightbox viewing, thumbnails, and captions.
265-
- Video Player: A component for embedding and controlling video playback, including custom controls and responsive design.
266-
- Audio Player: A component for embedding and controlling audio playback, similar to the video player.
267-
- Virtual List: A component for rendering large lists efficiently by only rendering the visible items and recycling DOM elements.
268-
- Notification Center: A component for managing and displaying a list of notifications, with features like dismissing and marking as read.
269-
- Map Viewer: A component for displaying interactive maps, possibly integrating with libraries like Leaflet or Google Maps API.
270-
- Rating/Review: A component for capturing and displaying user ratings and reviews, often used in e-commerce and feedback systems.
271-
- Timeline: A component for displaying chronological events or activities in a visually appealing timeline format.
251+
Form-Related Components
252+
<zephyr-form>: A wrapper component for handling form submissions, validation, and data management.
253+
<zephyr-checkbox>: A customizable checkbox input element with clear styling options.
254+
<zephyr-radio>: Similar to <zephyr-Checkbox, but for radio button groups.
255+
<zephyr-switch>: A toggle switch component for binary options.
256+
<zephyr-select>: A styled dropdown selection component.
257+
<zephyr-datepicker>: A calendar component for date input.
258+
<zephyr-timepicker>: A component for selecting time.
259+
<zephyr-calendar>: A full calendar component for scheduling and events
260+
<zephyr-range-slider>: An input slider for selecting a value within a range.
261+
<zephyr-file-upload>: A component for handling file uploads.
262+
<zephyr-multi-form>: Guides users through multi-step processes, such as checkout processes.
263+
Authentication Components
264+
<zephyr-login-form>: A pre-built login form component
265+
<zephyr-signup-form>: A registration form component
266+
<zephyr-password-strength>: A password strength indicator
267+
Utility Components
268+
<zephyr-scroll-to-top>: A button to scroll back to the top of the page
269+
<zephyr-infinite-scroll>: A component to handle infinite scrolling
270+
<zephyr-lazy-load>: A component for lazy loading images or other content
271+
Navigation & Layout Components
272+
Popover/Popover Menu: Similar to tooltips but more complex, allowing for interaction within the content.
273+
<zephyr-navbar>: A top-level navigation bar component.
274+
<zephyr-sidebar>: A collapsible side navigation menu.
275+
<zephyr-breadcrumb>: A navigational aid that shows the user's path within a website or application.
276+
<zephyr-grid>: A flexible grid system for creating responsive layouts (could integrate with a popular CSS grid library).
277+
<zephyr-carousel>: A slideshow component for displaying images or content.
278+
<zephyr-masonry>: A masonry layout component for dynamic content arrangement
279+
<zephyr-pagination>: A component to help users navigate through large sets of data.
280+
Data Visualization Components
281+
<zephyr-chart>: A generic chart component that can be configured for various chart types (line, bar, pie, etc.). Could potentially integrate with a charting library like Chart.js or D3.js.
282+
<zephyr-progress>: A progress bar or circle component for visualizing progress.
283+
<zephyr-timeline>: A component to display events or data points in chronological order.
284+
Interactive Components
285+
<zephyr-drawer>: A sliding panel that emerges from the side of the screen.
286+
<zephyr-snackbar>: A brief notification that appears at the bottom of the screen.
287+
<zephyr-rating>: A component for displaying and collecting user ratings (e.g., star ratings).
288+
Additional Ideas
289+
<zephyr-avatar>: A circular image component for displaying user profile pictures.
290+
<zephyr-badge>: A small label or tag to highlight a piece of information.
291+
<zephyr-loader/spinner>: Animated loading indicators to provide feedback during asynchronous operations.
292+
<zephyr-audio-player>: A component for playing audio files.
293+
<zephyr-video-player>: A component for playing video files.
294+
<zephyr-sortable-list>: Allows users to reorder list items via drag and drop.

0 commit comments

Comments
 (0)