tiennm99/github-readme-stats
1
0
Fork 0
mirror of https://github.com/tiennm99/github-readme-stats.git synced 2026-09-03 06:19:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Different default languages count for different languages card layouts (#2774)

Browse Source 
* Different default languages count for different layouts

* docs: update default  documentation

Updates the README so that the new `langs_count` default behavoir is
explained to users.

---------

Co-authored-by: rickstaa <rick.staa@outlook.com>
This commit is contained in:
Alexandr Garbuzov
2023-06-06 16:42:46 +02:00
committed by GitHub
co-authored by rickstaa
parent cec5ee3462
commit 894f2e2c5a
3 changed files with 39 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cards/top-languages-card.js
+28 -2
View File
@@ -14,11 +14,16 @@ import { langCardLocales } from "../translations.js";
const DEFAULT_CARD_WIDTH = 300;
const MIN_CARD_WIDTH = 280;
const DEFAULT_LANGS_COUNT = 5;
const DEFAULT_LANG_COLOR = "#858585";
const CARD_PADDING = 25;
const COMPACT_LAYOUT_BASE_HEIGHT = 90;
const NORMAL_LAYOUT_DEFAULT_LANGS_COUNT = 5;
const COMPACT_LAYOUT_DEFAULT_LANGS_COUNT = 6;
const DONUT_LAYOUT_DEFAULT_LANGS_COUNT = 5;
const PIE_LAYOUT_DEFAULT_LANGS_COUNT = 6;
const DONUT_VERTICAL_LAYOUT_DEFAULT_LANGS_COUNT = 6;
/**
* @typedef {import("../fetchers/types").Lang} Lang
*/
@@ -668,6 +673,26 @@ const noLanguagesDataNode = ({ color, text, layout }) => {
`;
};
/**
* Get default languages count for provided card layout.
*
* @param {import("./types").TopLangOptions["layout"] | undefined} layout Input layout string
* @return {number} Default languages count for input layout
*/
const getDefaultLanguagesCountByLayout = (layout) => {
if (layout === "compact") {
return COMPACT_LAYOUT_DEFAULT_LANGS_COUNT;
} else if (layout === "donut") {
return DONUT_LAYOUT_DEFAULT_LANGS_COUNT;
} else if (layout === "donut-vertical") {
return DONUT_VERTICAL_LAYOUT_DEFAULT_LANGS_COUNT;
} else if (layout === "pie") {
return PIE_LAYOUT_DEFAULT_LANGS_COUNT;
} else {
return NORMAL_LAYOUT_DEFAULT_LANGS_COUNT;
}
};
/**
* Renders card that display user's most frequently used programming languages.
*
@@ -689,7 +714,7 @@ const renderTopLanguages = (topLangs, options = {}) => {
layout,
custom_title,
locale,
langs_count = DEFAULT_LANGS_COUNT,
langs_count = getDefaultLanguagesCountByLayout(layout),
border_radius,
border_color,
disable_animations,
@@ -837,4 +862,5 @@ export {
trimTopLanguages,
renderTopLanguages,
MIN_CARD_WIDTH,
getDefaultLanguagesCountByLayout,
};