{"id":23395808,"url":"https://github.com/netgen/admin-ui-styles","last_synced_at":"2025-04-11T14:12:56.965Z","repository":{"id":57129934,"uuid":"135414896","full_name":"netgen/admin-ui-styles","owner":"netgen","description":"NPM package providing base styles for building admin UI interfaces","archived":false,"fork":false,"pushed_at":"2019-02-04T14:45:48.000Z","size":904,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-25T10:21:30.495Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netgen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-30T08:47:51.000Z","updated_at":"2019-10-10T08:22:22.000Z","dependencies_parsed_at":"2022-08-31T19:21:58.966Z","dependency_job_id":null,"html_url":"https://github.com/netgen/admin-ui-styles","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgen%2Fadmin-ui-styles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgen%2Fadmin-ui-styles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgen%2Fadmin-ui-styles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgen%2Fadmin-ui-styles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netgen","download_url":"https://codeload.github.com/netgen/admin-ui-styles/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248414861,"owners_count":21099559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-22T07:18:25.324Z","updated_at":"2025-04-11T14:12:56.944Z","avatar_url":"https://github.com/netgen.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Netgen UI\n\nStyles and js for simple Netgen Admin UI plugins.\nIncluding:\n- jsTree\n- buttons with effect\n- tabs\n- tooltips\n- resizable sidebar\n- checkbox enabled/disabled buttons\n\n## Install\n\nInstall the Node dependency:\n```\nyarn add @netgen/admin-ui\n```\nor\n```\nnpm install @netgen/admin-ui\n```\n\n## Using CSS\n\nImport styles to scss file:\n```scss\n@import \"@netgen/admin-ui/scss/style\";\n```\n\nYou also need to configure sass-loader to understand the `@netgen` imports from node_modules. Update your sass-loader config by changing `{ loader: 'sass-loader' }` to:\n```js\n{\n  loader: 'sass-loader',\n  options: {\n    includePaths: ['./node_modules']\n  }\n}\n```\n\nYou can override scss variables for base font family and path to main logo image:\n```scss\n$baseFont: 'Roboto', Helvetica, Arial, sans-serif;\n$mainLogoPath: '../images/ng-ui-logo.svg';\n```\n\nIf you don't use scss, you can include already built css file from `node_modules/@netgen/admin-ui/dist/css/style.css` or minified `style.min.css`.\n\n## Using JS\n\nTo include the ES2015 modules and initialize the plugins for all of the UI plugins:\n```js\nimport { NgUiInit } from '@netgen/admin-ui';\n\nNgUiInit();\n```\n\nIf you can't use ES2015 modules and don't need to initialize plugin on specific event, you can include already built js file from `node_modules/@netgen/admin-ui/dist/js/include/ngui.js` which initializes all of the UI plugins on window load.\n\n### Tree\n\nTo include only tree plugin and initialize it:\n```js\nimport { NgUiTreeInit } from '@netgen/admin-ui';\n\nNgUiTreeInit('ng-ui-tree-wrapper', { modal: true });\n```\n\nFirst parameter is the class name for tree element.\nSecond parameters are options for the tree:\n- modal - boolean - is the tree opened in modal window (default false)\n- treeClassName - string - class name for div on which jstree is initialized (default 'ng-ui-tree')\n- modalClassName - string - class name for modal div in which tree is opened (default 'ng-modal')\n\n### Tabs\n\nTo include only tabs plugin and initialize it:\n```js\nimport { NgUiTabsInit } from '@netgen/admin-ui';\n\nNgUiTabsInit('ng-ui-tabs');\n```\n\nFunction parameter is the class name for the tabs element (default 'ng-ui-tabs').\n\nHtml markup for the tabs should be:\n```html\n\u003cdiv class=\"ng-ui-tabs\"\u003e\n    \u003cul class=\"ng-ui-tab-controls\"\u003e\n        \u003cli\u003e\u003ca class=\"ng-ui-tab-control\" data-target=\"tab1\" href=\"#tab1\"\u003eTab1\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca class=\"ng-ui-tab-control\" data-target=\"tab2\" href=\"#tab2\"\u003eTab2\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca class=\"ng-ui-tab-control\" data-target=\"tab3\" href=\"#tab3\"\u003eTab3\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n    \u003cdiv class=\"ng-ui-tab\" data-tab=\"#tab1\"\u003e\n        Tab1 content\n    \u003c/div\u003e\n    \u003cdiv class=\"ng-ui-tab\" data-tab=\"#tab2\"\u003e\n        Tab2 content\n    \u003c/div\u003e\n    \u003cdiv class=\"ng-ui-tab\" data-tab=\"#tab3\"\u003e\n        Tab3 content\n    \u003c/div\u003e\n\u003c/div\u003e\n```\n\nLast active tab is remembered in localStorage.\n\n### Buttons\n\nTo include only buttons plugin and initialize it:\n```js\nimport { NgUiBtnInit } from '@netgen/admin-ui';\n\nNgUiTabsInit('ng-ui-btn');\n```\n\nFunction parameter is the class name for the button elements (default 'ng-ui-btn').\n\n### Tooltips\n\nTo include only tooltip plugin and initialize it:\n```js\nimport { NgUiTooltipInit } from '@netgen/admin-ui';\n\nNgUiTooltipInit('ng-ui-tt');\n```\n\nFunction parameter is the class name for the tooltip elements (default 'ng-ui-tt').\n\nRequired markup for a tooltip is only css class (default: 'ng-ui-tt', can be overriden with initialization parameter), and title attribute for element you wish to have a tooltip. Title can have html markup, but all of the quotes inside of it must be single.\nExample:\n```html\n\u003cspan class=\"ng-ui-tt\" title=\"Lorem ipsum \u003ca href='#'\u003edolor sit amet\u003c/a\u003e, consectetur?\"\u003esome text\u003c/span\u003e\n```\n\n### Sidebar resize\n\nPlugin initializes with main init function (NgUiInit).\nClass name for resizable sidebar div should be `'ng-ui-sidebar-resizable'`.\nResizable sidebar connects with main logo and resizes it while resizing sidebar. Logo class name should be `'ng-ui-logo'`.\n\n### Checkbox enable/disable buttons\n\nPlugin initializes with main init function (NgUiInit).\nUse it to enable/disable buttons with checkbox inputs.\n\nCheckbox inputs should have data-enable attribute `data-enable=\"Target\"`.\nButtons should have data-enabler attribute `data-enabler=\"Target\"`.\n\nIf none of the checkboxes with the same `data-enable` attribute is checked, buttons with that `data-disabler` attribute are disabled. If you check any of the checkboxes, buttons are enabled.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetgen%2Fadmin-ui-styles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetgen%2Fadmin-ui-styles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetgen%2Fadmin-ui-styles/lists"}