8.0.3-alpha.0 • Published 10 months ago

@ndla/licenses v8.0.3-alpha.0

Weekly downloads
341
License
GPL-3.0
Repository
github
Last release
10 months ago

ndla-licenses

A simple library for retrieving license information by abbreviation (and locale).

Installation

yarn add @ndla/licenses
npm install @ndla/licenses

Usage

Get license by abbreviation

import getLicenseByAbbreviation from "@ndla/licenses";

const license = getLicenseByAbbreviation("CC-BY-NC-4.0", "en");

console.log(license);
//> { short: 'Free use', title: 'Attribution-NonCommercial', description: 'This license...', rights: ['by', 'sa'] }

// defaults to Norsk Bokmål (nb)
const license = getLicenseByAbbreviation("CC-BY-NC-4.0", "unknown-locale");
console.log(license);
//> { short: 'Fri bruk', title: 'Navngivelse-IkkeKommersiell', description: 'Denne lisensen...', rights: ['by', 'sa'] }

// returns abbreviation if license is unknown
const license = getLicenseByAbbreviation("unknown-license", "en");
console.log(license);
//> { short: 'unknown-license', title: 'unknown-license', description: 'unknown-license', rights: [] }

Get license right info by abbreviation/constant

import { getLicenseRightByAbbreviation, BY, CC } from "@ndla/licenses";

const licenseRight = getLicenseRightByAbbreviation(BY, "en");

console.log(licenseRight);
//> { short: 'cc', title: 'Copyright', userFriendlyTitle: 'Copyright', description: 'Only the creator can derive...' }

// defaults to Norsk Bokmål (nb)
const licenseRight = getLicenseRightByAbbreviation(CC, "unknown-locale");
console.log(licenseRight);
//> { short: 'cc', title: 'Copyright', userFriendlyTitle: 'Opphavsrett', description: 'Bare opphavspersonen kan bearbeide...' }

// returns abbreviation if licenseRight is unknown
const licenseRight = getLicenseRightByAbbreviation("unknown-lr", "en");
console.log(licenseRight);
//> { short: 'unknown-lr', title: 'unknown-lr', userFriendlyTitle: 'unknown-lr', description: 'unknown-lr'}

License right constants

import { BY, SA } from "@ndla/licenses";
import Icon from "./Icons";

const LicenseIcon = ({ licenseRight }) => {
  switch (licenseRight) {
    case BY:
      return <Icon.LicenseBy />;
    case SA:
      return <Icon.LicenseSa />;
    default:
      return undefined;
  }
};

Available constants:

Exported nameValueDescription
BY'by'Attribution
SA'sa'Share-alike
NC'nc'Non-commercial
ND'nd'No derivative work
PD'pd'Public Domain
CC0'cc0'Public Domain Dedication
CC'cc'Copyright
8.0.3-alpha.0

10 months ago

8.0.2-alpha.0

10 months ago

8.0.0-alpha.0

1 year ago

8.0.1-alpha.0

11 months ago

7.2.6

1 year ago

7.2.5

2 years ago

7.2.4

2 years ago

7.1.4

2 years ago

7.1.3

2 years ago

7.1.2

2 years ago

7.1.1

2 years ago

7.2.2

2 years ago

7.2.0

2 years ago

7.1.0

2 years ago

7.0.4

2 years ago

7.0.3

2 years ago

7.0.2

2 years ago

6.2.1

2 years ago

7.0.0

2 years ago

7.0.1

2 years ago

6.1.2

3 years ago

6.1.1

3 years ago

6.1.4

3 years ago

6.1.3

3 years ago

6.2.0

2 years ago

6.1.6

3 years ago

6.1.5

3 years ago

6.1.8

2 years ago

6.1.7

2 years ago

6.1.0

3 years ago

6.0.10

3 years ago

6.0.9

3 years ago

5.0.18

3 years ago

6.0.7

3 years ago

6.0.6

3 years ago

6.0.8

3 years ago

6.0.1

3 years ago

6.0.0

3 years ago

6.0.5

3 years ago

6.0.4

3 years ago

5.0.12

3 years ago

5.0.13

3 years ago

5.0.14

3 years ago

5.0.15

3 years ago

5.0.16

3 years ago

5.0.17

3 years ago

5.0.9

3 years ago

5.0.8

3 years ago

5.0.7

3 years ago

5.0.6

3 years ago

5.0.5

3 years ago

5.0.3

3 years ago

5.0.2

3 years ago

5.0.1

3 years ago

5.0.10

3 years ago

5.0.0

3 years ago

5.0.11

3 years ago

4.1.4

3 years ago

4.1.3

3 years ago

4.1.5

3 years ago

4.0.5

3 years ago

4.0.4

3 years ago

4.1.0

3 years ago

4.1.2

3 years ago

4.1.1

3 years ago

4.0.1

3 years ago

4.0.3

3 years ago

4.0.2

3 years ago

2.2.0

3 years ago

3.0.1

3 years ago

3.0.0

3 years ago

4.0.0

3 years ago

3.0.2-alpha.12

3 years ago

2.1.1

3 years ago

2.1.0

3 years ago

1.2.0

3 years ago

1.0.8

3 years ago

2.0.0

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.1.9

3 years ago

1.1.8

3 years ago

1.1.7

3 years ago

1.1.6

3 years ago

1.1.4

3 years ago

1.1.3

3 years ago

1.1.2

3 years ago

1.0.7

4 years ago

1.0.4-alpha.0

4 years ago

1.0.6-alpha.0

4 years ago

1.0.6

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

0.6.53

4 years ago

0.6.52

4 years ago

0.6.51

4 years ago

0.6.50

4 years ago

0.6.47

4 years ago

0.6.49

4 years ago

0.6.46

4 years ago

0.6.45

4 years ago

0.6.44

4 years ago

0.6.43

4 years ago

0.6.42

4 years ago

0.6.41

4 years ago

0.6.40

4 years ago

0.6.39

5 years ago

0.6.38

5 years ago

0.6.37

5 years ago

0.6.36

5 years ago

0.6.35

5 years ago

0.6.34

5 years ago

0.6.33

5 years ago

0.6.32

5 years ago

0.6.31

5 years ago

0.6.30

5 years ago

0.6.29

5 years ago

0.6.28

5 years ago

0.6.27

5 years ago

0.6.26

5 years ago

0.6.25

5 years ago

0.6.24

5 years ago

0.6.23

5 years ago

0.6.22

6 years ago

0.6.21

6 years ago

0.6.20

6 years ago

0.6.19

6 years ago

0.6.18

6 years ago

0.6.17

6 years ago

0.6.16

6 years ago

0.6.15

6 years ago

0.6.14

6 years ago

0.6.13

6 years ago

0.6.12

6 years ago

0.6.11

6 years ago

0.6.10

6 years ago

0.6.8

6 years ago

0.6.7

6 years ago

0.6.6

6 years ago

0.6.5

6 years ago

0.6.4

6 years ago

0.6.3

6 years ago

0.6.2

6 years ago

0.6.1

6 years ago

0.6.0

6 years ago

0.4.4-alpha.0

6 years ago

0.5.0

6 years ago

0.4.4-alpha.87

6 years ago

0.4.3

7 years ago

0.4.2

7 years ago

0.4.1

7 years ago

0.4.0

7 years ago