Skip to content

Commit f7b5baf

Browse files
committed
Correct notes about compatibility, rebuild to make latest match, Add upgrade guide, Add changelog.md, rewrite getting started
1 parent ba3ae59 commit f7b5baf

8 files changed

Lines changed: 965 additions & 716 deletions

File tree

CHANGELOG.md

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
# Changelog
2+
3+
All notable changes to jAlert will be documented in this file.
4+
5+
## [5.0.0] - 2024-01-XX
6+
7+
### 🚀 Major Release - Complete Modernization
8+
9+
jAlert has been completely rewritten with modern development practices while maintaining 100% API compatibility. This release focuses on improved performance, better browser support, and enhanced features.
10+
11+
### ✨ New Features
12+
13+
- **🎠 Lightbox Slideshow**: Built-in image slideshow with advanced navigation
14+
- Next/previous arrow controls
15+
- Dot navigation or number counter
16+
- Auto-advance with configurable intervals
17+
- Keyboard navigation (arrow keys)
18+
- Pause on hover functionality
19+
- Loop option to restart at the end
20+
- Image sizing modes (fit current vs fit largest)
21+
- Caption support for slides
22+
- Responsive viewport sizing
23+
24+
- **🔧 Modern Build System**:
25+
- Webpack 5 for efficient bundling
26+
- Babel transpilation to ES5 for maximum compatibility
27+
- PostCSS with Autoprefixer for CSS compatibility
28+
- Source maps for debugging
29+
- Optimized production builds
30+
31+
- **🧪 Comprehensive Testing**:
32+
- Unit tests with Jest
33+
- End-to-end tests with Puppeteer
34+
- Visual regression testing
35+
- Automated test suite
36+
37+
### 🔧 Technical Improvements
38+
39+
- **Performance**: Optimized bundle size and loading
40+
- **Accessibility**: Enhanced keyboard navigation and screen reader support
41+
- **Mobile Support**: Improved responsive design and touch interactions
42+
- **Error Handling**: Better validation and error messages
43+
- **Code Organization**: Modular architecture with improved maintainability
44+
45+
### 🐛 Bug Fixes
46+
47+
- Fixed slideshow options not being deeply merged with defaults
48+
- Fixed loader persistence issues in slideshows
49+
- Fixed fitLargest sizing to respect viewport dimensions
50+
- Fixed legacy file references and cleanup
51+
- Fixed demo and asset organization
52+
53+
### 📦 Dependency Updates
54+
55+
- **jQuery**: Updated to 3.7.0+ (peer dependency)
56+
- **Build Tools**: Modernized to latest versions
57+
- **Browser Support**: ES5 compatible for maximum compatibility
58+
59+
### 🔄 Breaking Changes
60+
61+
**None!** This release maintains 100% backward compatibility with existing APIs.
62+
63+
### 📋 Upgrade Guide
64+
65+
#### For Existing Users
66+
67+
**No code changes required!** The API is identical to previous versions.
68+
69+
1. **Update your files**:
70+
```bash
71+
# Download the new version
72+
npm install jalert@5.0.0
73+
# Or download manually from GitHub
74+
```
75+
76+
2. **Update your HTML**:
77+
```html
78+
<!-- Old -->
79+
<script src="jAlert.min.js"></script>
80+
81+
<!-- New (same file, just updated) -->
82+
<script src="dist/jAlert.min.js"></script>
83+
```
84+
85+
3. **Ensure jQuery 3.7.0+**:
86+
```html
87+
<script src="https://code.jquery.com/jquery-3.7.0.min.js"></script>
88+
```
89+
90+
#### For New Users
91+
92+
1. **Install via NPM**:
93+
```bash
94+
npm install jalert
95+
```
96+
97+
2. **Include in your project**:
98+
```html
99+
<link rel="stylesheet" href="node_modules/jalert/dist/jAlert.min.css">
100+
<script src="https://code.jquery.com/jquery-3.7.0.min.js"></script>
101+
<script src="node_modules/jalert/dist/jAlert.min.js"></script>
102+
```
103+
104+
3. **Start using**:
105+
```javascript
106+
$.jAlert({
107+
title: 'Hello World',
108+
content: 'Welcome to jAlert 5.0!'
109+
});
110+
```
111+
112+
### 🎯 New Slideshow Feature
113+
114+
The slideshow feature is the highlight of this release:
115+
116+
```javascript
117+
$.jAlert({
118+
slideshow: [
119+
'image1.jpg',
120+
'image2.jpg',
121+
'image3.jpg'
122+
],
123+
slideshowOptions: {
124+
autoAdvance: true,
125+
autoAdvanceInterval: 3000,
126+
showArrows: true,
127+
showCounter: 'dots', // or 'numbers'
128+
keyboardNav: true,
129+
loop: true,
130+
pauseOnHover: true,
131+
resizeMode: 'fitLargest' // or 'fitCurrent'
132+
}
133+
});
134+
```
135+
136+
### 🌐 Browser Compatibility
137+
138+
- **IE11+** (ES5 compatible)
139+
- **Chrome 60+**
140+
- **Firefox 55+**
141+
- **Safari 12+**
142+
- **Edge 79+**
143+
144+
### 📚 Documentation
145+
146+
- Complete API documentation in README
147+
- Interactive demos on the website
148+
- Comprehensive examples for all features
149+
- Development guidelines for contributors
150+
151+
### 🛠️ Development
152+
153+
- Modern development workflow with npm scripts
154+
- Automated testing and quality assurance
155+
- Source maps for debugging
156+
- Optimized build process
157+
158+
---
159+
160+
## [4.6.6] - Previous Release
161+
162+
### Fixed
163+
- Added alert margin to ensure close button visibility
164+
165+
## [4.6.5] - Previous Release
166+
167+
### Fixed
168+
- Fixed scroll issue with flexbox layout
169+
170+
## [4.6.4] - Previous Release
171+
172+
### Changed
173+
- Rewritten alert positioning to use flexbox
174+
- Removed centerAlert method
175+
176+
### Fixed
177+
- All links updated to new GitHub username "HTMLGuyLLC"
178+
- Fixed version references in code
179+
- Fixed Codepen demos
180+
- Fixed NPM package
181+
182+
## [4.6.2] - Previous Release
183+
184+
### Fixed
185+
- Fixed top-margin when alert is larger than screen
186+
- Fixed round close button default font color
187+
188+
## [4.6.1] - Previous Release
189+
190+
### Fixed
191+
- Fixed autoclose option
192+
193+
## [4.6.0] - Previous Release
194+
195+
### Added
196+
- Added autoclose option
197+
198+
## [4.5.1] - Previous Release
199+
200+
### Added
201+
- Added fullscreen option
202+
203+
## [4.5] - Previous Release
204+
205+
### Changed
206+
- Removed minified files from src folder
207+
- Added distribution folder (dist)
208+
209+
### Fixed
210+
- Fixed duplicate button callbacks
211+
212+
## [4.036] - Previous Release
213+
214+
### Changed
215+
- Removed borders for no-title alerts and iframes
216+
- Added box-shadow back
217+
218+
---
219+
220+
For older versions, see the [GitHub releases page](https://github.com/HTMLGuyLLC/jAlert/releases).

0 commit comments

Comments
 (0)