PPTXKit

A Swift library for displaying and navigating PowerPoint (PPTX) presentations in iOS and macOS applications, with a companion CLI tool for testing and analysis.

Overview

PPTXKit is a powerful Swift library that enables native iOS and macOS applications to display, render, and navigate PowerPoint presentations without requiring Microsoft Office. Built on the ECMA-376 Office Open XML standard, it provides high-fidelity rendering of slides with support for text, shapes, images, and theme colors.

The project includes a command-line tool (pptx-analyzer) that's perfect for testing PPTXKit's capabilities and analyzing PPTX files during development.

Why PPTXKit?

Native Performance - Built with Swift for optimal performance on Apple platforms
No Dependencies on Office - Display PowerPoint files without Microsoft Office installed
Easy Integration - Simple API for adding PPTX viewing to your iOS/macOS apps
Full Rendering Support - Accurately renders text, shapes, images, and theme colors
SwiftUI & UIKit/AppKit - Works seamlessly with both UI frameworks

Features

Core Library (PPTXKit)

🎨 High-Fidelity Rendering - Accurate slide rendering with proper layout and styling
🖼️ Image Support - Full support for embedded images (PNG, JPEG, TIFF)
📱 Native Views - Render slides as native iOS/macOS views or export as images
🎯 Navigation API - Simple presentation management and slide navigation
🎨 Theme Support - Proper handling of PowerPoint theme colors and styles
🔤 Text Rendering - Accurate text positioning with font styles and formatting
🔷 Shape Rendering - Support for rectangles, ellipses, stars, hearts, polygons, arrows, and custom shapes
🎨 Advanced Fills - Solid colors, linear gradients with luminance modifications, and no-fill support
🖊️ Stroke Support - Full stroke/border rendering with color and width control
📊 Table Rendering - Support for PowerPoint tables with cell styling and borders
🚀 Performance - On-demand parsing and rendering for optimal performance

CLI Tool (pptx-analyzer)

📊 Slide Analysis - Quick slide count and content extraction
📋 Batch Processing - Process multiple presentations programmatically
🔍 Debugging - Inspect slide structure and relationships
🖼️ Export - Render slides as PNG images for testing
📈 Comparison Tools - Compare rendering output with PowerPoint references

Installation

Swift Package Manager

Add PPTXKit to your iOS or macOS project:

dependencies: [
    .package(url: "https://github.com/yourusername/pptx-swift.git", from: "1.0.0")
]

Then add PPTXKit to your target dependencies:

targets: [
    .target(
        name: "YourApp",
        dependencies: ["PPTXKit"]
    )
]

Quick Start

Basic SwiftUI App

import SwiftUI
import PPTXKit

struct ContentView: View {
    @StateObject private var manager = PPTXManager()
    
    var body: some View {
        VStack {
            if manager.isLoaded {
                PPTXPresentationView(manager: manager)
                    .navigationControlsVisible(true)
            } else {
                Button("Open Presentation") {
                    openPresentation()
                }
            }
        }
    }
    
    func openPresentation() {
        // For iOS: Use document picker
        // For macOS: Use NSOpenPanel
        if let url = selectPPTXFile() {
            try? manager.loadPresentation(from: url)
        }
    }
}

Basic UIKit App

import UIKit
import PPTXKit

class ViewController: UIViewController {
    let manager = PPTXManager()
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        // Load presentation
        if let url = Bundle.main.url(forResource: "presentation", withExtension: "pptx") {
            try? manager.loadPresentation(from: url)
            
            // Create presentation view controller
            let presentationVC = PPTXPresentationViewController(manager: manager)
            
            // Add as child view controller
            addChild(presentationVC)
            view.addSubview(presentationVC.view)
            presentationVC.view.frame = view.bounds
            presentationVC.didMove(toParent: self)
        }
    }
}

Advanced Usage

Custom Slide Rendering

import PPTXKit
import SwiftUI

struct CustomSlideView: View {
    let document: PPTXDocument
    @State private var currentSlide = 1
    
    var body: some View {
        VStack {
            // Slide view with custom styling
            PPTXSlideViewUI(document: document, slideIndex: currentSlide)
                .renderingQuality(.high)
                .frame(width: 800, height: 600)
                .cornerRadius(10)
                .shadow(radius: 5)
            
            // Custom navigation
            HStack {
                Button("Previous") {
                    if currentSlide > 1 {
                        currentSlide -= 1
                    }
                }
                
                Text("Slide \(currentSlide) of \(try? document.getSlideCount() ?? 0)")
                
                Button("Next") {
                    if currentSlide < (try? document.getSlideCount() ?? 0) {
                        currentSlide += 1
                    }
                }
            }
        }
    }
}

Export Slides as Images

import PPTXKit

// Export single slide
let document = try PPTXDocument(filePath: "presentation.pptx")
let slide = try document.getSlide(at: 1)

let renderer = SlideRenderer(
    context: RenderingContext(size: CGSize(width: 1920, height: 1080))
)
let image = try renderer.render(slide: slide!, archive: document.archive)

// Save as PNG
if let data = image.pngData() {
    try data.write(to: URL(fileURLWithPath: "slide1.png"))
}

// Export all slides
for i in 1...(try document.getSlideCount()) {
    if let slide = try document.getSlide(at: i) {
        let image = try renderer.render(slide: slide, archive: document.archive)
        // Save each slide...
    }
}

Extracting Content

import PPTXKit

let document = try PPTXDocument(filePath: "presentation.pptx")

// Get presentation metadata
let metadata = try document.getMetadata()
print("Title: \(metadata.title ?? "Untitled")")
print("Author: \(metadata.author ?? "Unknown")")
print("Created: \(metadata.created ?? Date())")

// Extract text from all slides
let slides = try document.getSlides()
for slide in slides {
    print("\nSlide \(slide.index):")
    for text in slide.textContent {
        print("  - \(text)")
    }
}

CLI Tool Usage

The included pptx-analyzer CLI tool is great for:

Testing PPTXKit functionality during development
Batch processing presentations
Quick analysis and debugging

Installation

git clone https://github.com/yourusername/pptx-swift.git
cd pptx-swift
swift build -c release
sudo cp .build/release/pptx-analyzer /usr/local/bin/

Basic Commands

# Get presentation summary
swift run pptx-analyzer summary presentation.pptx

# Render single slide to PNG
swift run pptx-analyzer render presentation.pptx --slide 1 --output slide1.png

# Batch render all slides
for i in {1..6}; do
  swift run pptx-analyzer render presentation.pptx --slide $i --output slide_$i.png
done

# Compare with PowerPoint output
./scripts/compare_rendering.sh presentation.pptx 6

See CLI Usage Guide for complete documentation.

Use Cases

PPTXKit is perfect for:

Educational Apps - Display course materials and lectures without requiring PowerPoint
Business Apps - View presentations in meeting apps, CRM systems, or document viewers
Kiosk/Display Systems - Show presentations on digital signage or information displays
Document Management - Preview PowerPoint files in document management systems
Presentation Tools - Build custom presentation apps with unique features
Content Processing - Extract and analyze presentation content programmatically

Sample Applications

Complete sample apps demonstrate real-world usage:

Examples (Simple Learning Projects)

Located in Examples/ directory:

BasicViewer - Minimal SwiftUI app showing how to display presentations
CustomRendering - Advanced rendering and styling examples
ContentExtraction - Extract text and metadata from presentations

Apps (Full Applications)

Located in Apps/ directory:

iOS Viewer (Apps/PPTXViewer-iOS/)
- Document browser integration
- Full presentation navigation
- Gesture support (swipe between slides)
- Share and export functionality
macOS Viewer (Apps/PPTXViewer-macOS/)
- Split view with slide thumbnails
- Keyboard navigation
- Full-screen presentation mode
- Quick Look integration

See Examples README for quick start examples.

Documentation

Core Documentation

API Reference - Complete PPTXKit library documentation
Rendering Plan - Current implementation status and roadmap

Usage Guides

CLI Usage Guide - Command-line tool usage and examples
Rendering Comparison Guide - Compare PPTXKit output with PowerPoint
Table Implementation - Table rendering details
Gradient & Stroke Implementation - Advanced rendering features

Architecture

PPTXKit is designed with a modular architecture:

PPTXKit/
├── Core/
│   ├── PPTXDocument        # Main document interface
│   ├── SlideXMLParser      # Advanced XML parsing with layout support
│   └── Parsers/            # Various XML parsers for PPTX structure
├── Rendering/
│   ├── SlideRenderer       # Core rendering engine
│   ├── ImageRenderer       # Image loading and rendering
│   └── ShapeRenderer       # Shape and geometry rendering
├── Platform/
│   ├── PPTXSlideView       # Native UIKit/AppKit view
│   ├── PPTXSlideViewUI     # SwiftUI wrapper
│   └── PPTXManager         # Presentation state management
└── Models/
    ├── Slide               # Slide data model
    ├── Shape               # Shape definitions
    └── Theme               # Theme color support

Requirements

Swift 5.9 or later
macOS 13.0+ or iOS 16.0+
Xcode 15.0+ (for development)

Dependencies

Swift Argument Parser - CLI argument parsing
ZIPFoundation - ZIP archive handling

Contributing

We welcome contributions! PPTXKit is an active project with opportunities for:

Additional shape type support
Animation and transition rendering
Performance optimizations
Platform-specific features
Documentation improvements

See the Development Guide for setup instructions and coding guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built on the ECMA-376 Office Open XML specification
Designed for the Apple developer community
Created to enable PowerPoint viewing without Microsoft Office dependencies
Special thanks to all contributors and users who have helped improve PPTXKit

codelynx/pptx-swift

PPTXKit

Overview

Why PPTXKit?

Features

Core Library (PPTXKit)

CLI Tool (pptx-analyzer)

Installation

Swift Package Manager

Quick Start

Basic SwiftUI App

Basic UIKit App

Advanced Usage

Custom Slide Rendering

Export Slides as Images

Extracting Content

CLI Tool Usage

Installation

Basic Commands

Use Cases

Sample Applications

Examples (Simple Learning Projects)

Apps (Full Applications)

Documentation

Core Documentation

Usage Guides

Architecture

Requirements

Dependencies

Contributing

License

Acknowledgments