azkar.nvim

A Neovim plugin for Islamic reminders, starting with prayer times powered by the Al-Adhan API.

Features

• Display daily prayer times in a beautiful centered popup
• Location-based prayer times (by city or coordinates)
• Shows current Hijri date
• Highlights the next upcoming prayer
• Customizable UI and calculation methods

Installation

Using lazy.nvim

{
  "JOSA-OpenLab/azkar.nvim",
  dependencies = {
    "nvim-lua/plenary.nvim",
  },
  config = function()
    require("azkar").setup({
      -- Your configuration here
    })
  end,
}

Using packer.nvim

use {
  "JOSA-OpenLab/azkar.nvim",
  requires = { "nvim-lua/plenary.nvim" },
  config = function()
    require("azkar").setup()
  end
}

Configuration

require("azkar").setup({
  -- Location settings
  location = {
    city = "Amman",           -- Your city name
    country = "Jordan",       -- Your country
    -- OR use coordinates for more accuracy:
    -- latitude = 31.9454,
    -- longitude = 35.9284,
  },

  -- Calculation method (see below for options)
  method = 4, -- Umm Al-Qura University, Makkah

  -- UI settings
  ui = {
    width = 50,               -- Popup width
    height = 15,              -- Popup height
    border = "rounded",       -- Border style: "none", "single", "double", "rounded", "solid", "shadow"
    title = " Prayer Times ",
  },

  -- Keymaps
  keymaps = {
    toggle = "<leader>pt",    -- Toggle prayer times popup
    setup_location = "<leader>pl", -- Setup location
  },
})

Calculation Methods

Method	Description
0	Shia Ithna-Ansari
1	University of Islamic Sciences, Karachi
2	Islamic Society of North America
3	Muslim World League
4	Umm Al-Qura University, Makkah
5	Egyptian General Authority of Survey
7	Institute of Geophysics, University of Tehran
8	Gulf Region
9	Kuwait
10	Qatar
11	Majlis Ugama Islam Singapura, Singapore
12	Union Organization Islamic de France
13	Diyanet İşleri Başkanlığı, Turkey
14	Spiritual Administration of Muslims of Russia

Usage

Commands

• :Azkar - Toggle the prayer times popup
• :AzkarSetLocation - Set your location interactively

Keymaps (default)

• <leader>pt - Toggle prayer times popup
• <leader>pl - Setup location

Roadmap

• Prayer times display
• Azkar (morning/evening remembrances)
• Quran verses
• Islamic calendar events
• Prayer time notifications
• Qibla direction

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see LICENSE for details.

Credits

• Al-Adhan API for providing the prayer times data
• Islamic Network for maintaining the API