PHPackages                             navio/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. navio/sdk

ActiveLibrary[Utility & Helpers](/categories/utility)

navio/sdk
=========

SDK for building external Navio modules

1.3.4(2w ago)05MITPHPPHP ^8.4

Since Mar 25Pushed 2w agoCompare

[ Source](https://github.com/mrzh4s/navio-modules-sdk)[ Packagist](https://packagist.org/packages/navio/sdk)[ RSS](/packages/navio-sdk/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (6)Dependencies (2)Versions (8)Used By (0)

Navio Module SDK
================

[](#navio-module-sdk)

The official SDK for building external modules for the [Navio](https://navio.com) platform. This package provides the contracts and base classes that modules must implement to integrate with the platform's module registry, menu system, permissions, and UI renderer.

Requirements
------------

[](#requirements)

- PHP 8.4+
- Laravel 13+
- Navio platform 1.4.0+

Installation
------------

[](#installation)

```
composer require navio/sdk
```

Overview
--------

[](#overview)

An Navio module is a self-contained feature package that integrates into the platform. Modules can:

- Register admin and app sidebar menus
- Declare permissions synced into the platform's permission system
- Add settings pages to the admin panel
- Bring their own database migrations and routes
- Render UI pages using the platform's component library (no React required)
- Bind ports (interfaces) to adapters following Hexagonal Architecture

---

Creating a Module
-----------------

[](#creating-a-module)

### 1. Module Definition

[](#1-module-definition)

Create a class extending `AbstractModuleDefinition`. Only `slug()` and `name()` are required — everything else has sensible defaults.

```