Skip to content

A WordPress plugin that enables users to create and display a responsive, timeline on their WordPress site

License

Notifications You must be signed in to change notification settings

RAHB-REALTORS-Association/Timeline-WP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Timeline-WP

Description

Timeline-WP is a WordPress plugin that enables users to create and display a responsive, timeline on their WordPress site. This plugin utilizes React to render timeline items, which can dynamically display detailed event descriptions in a modal upon clicking.

Current Plugin offers a modern way to display timelines on your website. With its current capabilities and planned future enhancements, it stands out for its flexibility and user-friendly interface. Here’s what it currently offers and what's on the roadmap for future updates:

Current Features

  • Vertical Timeline Layout: Presents timeline events in a Vertical line, offering a broad view of the timeline that's both intuitive and visually engaging.
  • Hardcoded Data Loading: The timeline to load event details with hardcoded values with minimal loading time.
  • Continuous, adjustable dotted line across the timeline
  • Responsive design that adapts to various screen sizes

Planned Features in Next Updates

  • Horizontal Timeline Layout: Presents timeline events in a horizontal line, offering a broad view of the timeline that's both intuitive and visually engaging.Enhancements to the layout for improved responsiveness and interactivity.
  • Dynamic Data Loading for Event Details: Enables the timeline to dynamically load event details, ensuring that the content is always up to date with minimal loading time.Upgrades to how data is fetched and displayed, aiming for even smoother user experiences and integration options.

Installation

  1. Download the Timeline-WP.zip file from the Releases section.
  2. Go to your WordPress admin panel, navigate to Plugins > Add New, and click the Upload Plugin button.
  3. Choose the downloaded Timeline-WP.zip file and click Install Now.
  4. After installation, activate the plugin through the Plugins menu in WordPress.

Usage

To add a timeline to your page or post, use the following tag to add content with your actual timeline data:

<div id="timeline-wp"></div> [timeline-wp]

Contributing

Contributions are welcome! Please read our contributing guidelines in CONTRIBUTING.md for more information on how to report issues, submit pull requests, and contribute to the code.

License

This project is licensed under the GNU General Public License v2.0. See the LICENSE file for more details.

Code of Conduct

We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the code_of_conduct.md so that you can understand what actions will and will not be tolerated.