Installations
npm install @progress/kendo-theme-material
Releases
Developer
telerik
Developer Guide
Module System
CommonJS
Min. Node Version
Typescript Support
No
Node Version
20.18.0
NPM Version
lerna/8.1.9/node@v20.18.0+x64 (linux)
Statistics
149 Stars
10,221 Commits
71 Forks
55 Watching
54 Branches
168 Contributors
Updated on 27 Nov 2024
Languages
HTML (58.66%)
SCSS (28.13%)
TypeScript (12.77%)
JavaScript (0.31%)
Shell (0.09%)
Nunjucks (0.04%)
CSS (0.02%)
Total Downloads
Cumulative downloads
Total Downloads
7,345,768
Last day
1.2%
8,304
Compared to previous day
Last week
2.4%
40,247
Compared to previous week
Last month
6.3%
177,897
Compared to previous month
Last year
31.1%
2,063,044
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Kendo UI Themes Monorepo
kendo-themes
is a lerna managed monorepo project for all Kendo UI themes that are used across the Kendo UI suites and Telerik UI for Blazor. The themes are built with sass using scss syntax. The syntax is compatible with both node-sass
and dart-sass
, as we currently do not use the sass module system. Browser-specific properties are generated at build-time through PostCSS autoprefixer.
Setup
- Make sure you have Node v20 or later.
- Clone the repo and run
npm ci
to install dependencies.
Development Server
To run it, execute npm start
and navigate to http://localhost:3000/
Building Packages
The following npm commands are available for building the themes:
- To build all themes run
npm run sass
. - To build all swatches run
npm run sass:swatches
.
There are additional commands, which can be found in package.json
and gulpfile.js
.
Directory structure
- build -- various bash scripts
- lib -- files which we didn't put elsewhere
- packages
- theme-name
- build -- theme specific files needed for building
- docs -- per theme documentation
- lib -- files that are not strictly scss, like swatches in json format
- scripts -- theme specific javascript files
- scss -- source of the themes
- theme-name
- scripts -- various javascript files
- tests -- visual tests
Development
Inside each theme source directory, there is a per-component directory containing the respective styles.
Note: we mostly have aptly named direcotries, so they match component names. In few cases, however, we chose different names. For example, multicolumncombobox
is a mouthful, so its directory is dropdowngrid
.
Each component consists of index
file that is the entry points for component styles. Inside, we import core
files, all dependencies (for example, datepicker needs calendar) and the components layout
(metrics) and theme
(appearance) files.
Note: We list all dependencies is because we want components to be compiled standalone without the developer needing to know which component depends on which other component. However, recursive importing creates exponentially large dist files, unles handled.
To workaround this limitation, we use a mixin --
import-once
-- which takes care to output only once!
During development, the scss files are linted on every commit
and built on every push
command.
Changes in develop
branch release a new package version every monday in the dev
channel and in (version)-dev.(integer)
format. To install the latest development version of a given theme, run npm install (themename)@dev
-- for example, npm install @progress/kendo-theme-default@dev
.
Stable channel is released manually trough a github action.
Visual tests
To guard against regressions and make pull request reviews easier, the CI build makes screenshots of the sample pages in packages/html/src/[component]/tests/*.html
. This happens automatically for all feature branches. The sample pages contain static HTML that is the recommended rendering for components that use the theme.
To generate screenshots for a specific theme:
- Build the theme with
npm run sass
- Run
npm run create-screenshots <theme>
, substituting<theme>
with a theme name.
These steps will create new screenshots in tests/_output
. Note that due to platform differences, all of the files will be marked as changed.
Embedding Resources
To avoid hosting-related issues in projects that use the themes, the resources are embedded by encoding them in the output CSS. For more details, refer to this issue.
To embed the latest resources:
- Run the
npm run embed-assets
task. The task generates a file with the same name which registers a Base64-encoded version in the$data-uris
SCSS map. For example, thefoo.woff
font file will be encoded in afoo.scss
file which can later be imported through@import './font/foo';
. - Inline the encoded file inside the CSS through
map-get( $data-uris, 'foo.woff' )
. For example:
1$web-font-uri: map-get( $data-uris, 'WebComponentsIcons.woff' ); 2 3@font-face { 4 font-family: 'WebComponentsIcons'; 5 src: url( $web-font-uri ) format( "woff" ); 6}
Documenting Variables
The available variables for customizing each theme are listed in the article on customization for each theme (docs/customization.md
) The file is generated from the SCSS source files by running the npm run docs
command.
To document a variable, use triple-slash comments (///
) before its definition.
1/// Variable description 2$foo: 42 !default;
To group variables, use the @group
directive.
1/// Variable description 2/// @group random 3$foo: 42 !default; 4 5/// Another variable description 6/// @group random 7$bar: 1024 !default;
To change the layout or the front meter of the generated help topic, change the docs/_templates/customization.md.njk
source file.
License
This package is part of the following suites:
All available Kendo UI commercial licenses may be obtained at http://www.telerik.com/purchase/kendo-ui.
If you do not own a commercial license, the usage of this software shall be governed by the Apache License, Version 2.0.
Copyright © 2021 Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish_nuget.yml:21
Reason
no binaries found in the repo
Reason
Found 11/15 approved changesets -- score normalized to 7
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_compile-themes.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_compile-themes.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_compile-themes.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_compile-themes.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_compile-themes.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_compile-themes.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_compile-themes.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_compile-themes.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_create-screenshots.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_create-screenshots.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_create-screenshots.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_create-screenshots.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_create-screenshots.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_create-screenshots.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_create-screenshots.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_create-screenshots.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_create-screenshots.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_create-screenshots.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_lint-scripts.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_lint-scripts.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_lint-scripts.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_lint-scripts.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_lint-scripts.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_lint-scripts.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_lint-styles.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_lint-styles.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_lint-styles.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_lint-styles.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_lint-styles.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_lint-styles.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_prime-cache.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_prime-cache.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_prime-cache.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_prime-cache.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_prime-cache.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_prime-cache.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_render-test-pages.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_render-test-pages.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_render-test-pages.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_render-test-pages.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_render-test-pages.yml:93: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_render-test-pages.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_render-test-pages.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_render-test-pages.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_render-test-pages.yml:156: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_render-test-pages.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_test-contrast.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_test-contrast.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_test-contrast.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_test-contrast.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_test-contrast.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_test-contrast.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/_test-contrast.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/_test-contrast.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/ci.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/ci.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci_weekly.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/ci_weekly.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci_weekly.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/ci_weekly.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci_weekly.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/ci_weekly.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/merge_develop.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/merge_develop.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_npm.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_npm.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_npm.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_npm.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_npm.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_npm.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_npm_dev.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_npm_dev.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_npm_dev.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_npm_dev.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_npm_dev.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_npm_dev.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_nuget.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_nuget.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_nuget.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_nuget.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_nuget.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_nuget.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_nuget.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_nuget.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish_swatches.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_swatches.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_swatches.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_swatches.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_swatches.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_swatches.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_swatches.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_swatches.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish_swatches.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/publish_swatches.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/tag_stable.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/tag_stable.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tag_stable.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/tag_stable.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tag_stable.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/telerik/kendo-themes/tag_stable.yml/develop?enable=pin
- Info: 0 out of 45 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 6 third-party GitHubAction dependencies pinned
- Info: 12 out of 12 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish_npm.yml:14
- Info: jobLevel 'packages' permission set to 'read': .github/workflows/publish_npm.yml:15
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish_npm_dev.yml:21
- Info: jobLevel 'packages' permission set to 'read': .github/workflows/publish_npm_dev.yml:22
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish_nuget.yml:27
- Info: jobLevel 'packages' permission set to 'read': .github/workflows/publish_nuget.yml:28
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish_swatches.yml:28
- Info: jobLevel 'packages' permission set to 'read': .github/workflows/publish_swatches.yml:29
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/tag_stable.yml:14
- Info: jobLevel 'packages' permission set to 'read': .github/workflows/tag_stable.yml:15
- Warn: no topLevel permission defined: .github/workflows/_compile-themes.yml:1
- Warn: no topLevel permission defined: .github/workflows/_create-screenshots.yml:1
- Warn: no topLevel permission defined: .github/workflows/_lint-scripts.yml:1
- Warn: no topLevel permission defined: .github/workflows/_lint-styles.yml:1
- Warn: no topLevel permission defined: .github/workflows/_prime-cache.yml:1
- Warn: no topLevel permission defined: .github/workflows/_render-test-pages.yml:1
- Warn: no topLevel permission defined: .github/workflows/_test-contrast.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci_develop.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci_weekly.yml:1
- Warn: no topLevel permission defined: .github/workflows/merge_develop.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish_npm.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish_npm_dev.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish_nuget.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish_swatches.yml:1
- Warn: no topLevel permission defined: .github/workflows/tag_stable.yml:1
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 26 are checked with a SAST tool
Reason
13 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-7hpj-7hhx-2fgx
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-7q7g-4xm8-89cq
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
- Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Score
4.8
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More