Adding a new page

NodeBB Development
  • #1

    My requirement was to add a map icon and the corresponding route /map besides the other NodeBB icons i.e. Users, Tags, etc. I was able to modify the code and add it.

    Now I want to display a map in the "/map" page with the corresponding backend storing the latitude and longitude etc. of a particular user. But I am stuck. I looked at the existing .tpl files and to my surprise, they belong to the node_modules folders.

    Could anybody pl. guide me what is the best way to address this requirement?


  • Global Moderator Plugin & Theme Dev

    You want to create a plugin to do this. Take a look at nodebb-plugin-quickstart

  • #3

    Thank you for the reply. By creating a new plugin, I am still unaware about how to add/display a map icon besides the other standard NodeBB icons like Tags, Users, etc.

    I went through this example plugin but still not successful. Can you pl. guide me further?

  • Global Moderator Plugin & Theme Dev

    You want to display a navigation icon? The easiest way is to just add a new custom item at ACP -> General -> Navigation.

  • #5

    No.. not only simple display but with lots of additional functionality.. When the icon is clicked, I need to show a map and allow the user to place a marker on it and then save the corresponding latitude/longitude in the db.

  • #6

    Thanks I am able to add a custom icon including the route. Now could you pl. let me know where (in which files) in the associated plugin I am supposed to write the logic for this route?

  • #7
    //My Map Plugin: library.js
    plugin.init = function(params, callback) {
    	var router = params.router,
    		hostMiddleware = params.middleware,
    		hostControllers = params.controllers;
    	router.get('/map', hostMiddleware.admin.buildHeader, controllers.renderMapPage);
    	router.get('/api/map', controllers.renderMapPage);

    When I browse this URL: localhost/map

    I get the error in /public/src/admin/admin.js
    Line Number: 122 -- Cannot read matches property of null I debugged it and the undefined is the matches variable.

    Are these routes correct?
    router.get('/map', hostMiddleware.admin.buildHeader, controllers.renderMapPage);
    router.get('/api/map', controllers.renderMapPage);

  • Global Moderator Plugin & Theme Dev

    Yeah those should work. What is inside renderMapPage? The error you mentioned is a client-side error in the ACP, I can't think of any reason that would occur because of something you did, it's probably unrelated.

  • #9

    Thank you for your kind support, Pita.

    Controllers.renderMapPage = function (req, res, next) {
    //Render the templates/map.tpl
    res.render('map', {});

    Kindly help me solve it.

  • #10

    I think admin.js is expecting a url something like this... /admin/plugin/map whereas in my case it is simply "/map" I may not be correct.

    Kindly note that when I click the Map icon (whose route is /map) things work fine. But when I browse by entering this localhost/map in the browser and press Enter, it throws a client-side error in admin.js file.

  • Global Moderator Plugin & Theme Dev

    Oh, sorry, I missed that issue. It should be hostMiddleware.buildHeader, not hostMiddleware.admin.buildHeader. Remove the admin part, as it tells the server to render map as part of the admin control panel.

  • #12

    You are awesome. It worked. Thanks once again.

    So I will place my third-party client-side JS libraries in static/lib (alngside main.js) And the system will minify/uglify them. Right?

  • #13

    My map.tpl
    <div id="mapid" class="map"></div>

    My plugin.json
    "scripts": [

    My main.js

      $(document).ready(function() {
    requirejs(["leaflet"], function(L) {
    		var map ='mapid', {
    			attributionControl: false
    		}).setView(initialLocation, 12);


    Error: leaflet Uncaught Error: Map container not found.

    The <div id="mapid"> must be added to the DOM before calling'mapid').

    This jquery reaady function is called after the DOM and page (map.tpl) are loaded. But still getting error. Where am I wrong?

    Kindly help me.

  • Global Moderator Plugin & Theme Dev

    The way you have it there, it will run on every page. I'd suggest checking (a boolean) before running those things.

    You might try putting a debugger; statement in there before the require call and check that the map is actually in the DOM when you expect it to be.

  • #15

    if( == true) {

    requirejs(["leaflet"], function(L) {


    It returns undefined everytime including when I click the map icon. It returns true only when I enter this URL: localhost/map and press Enter. When it returns true, the "Error: leaflet Uncaught Error: Map container not found." is still there.

    I will use the debugger; and see what it reports.

  • #16

    Using the debugger statement indicated that the map is not in the DOM

  • #17

    Any answers?

  • Global Moderator Plugin & Theme Dev

    So if the map element isn't in the DOM, there's probably something wrong with your template. Check it, make sure it is correct. Check the built template in nodebb/build/public/templates to make sure it is correct.

  • #19

    The map.tpl has just one line. And the map.tpl in the build directory is simply a replica of my map.tpl.

  • Global Moderator Plugin & Theme Dev

    Ok, and when you go to /map directly, that is, not from another link on your site, is the map element in the source for the page?

Suggested Topics

| | | |