mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
28381 commits 1 branch 183 tags 5.3 GiB
Commit graph

97 commits

Author SHA1 Message Date
Keeley Hammond
9e421e8f43
docs: add docs API history (#43362) 
feat: add API history
 2024-08-19 17:13:55 -04:00
Erick Zhao
2f133f5e28
docs: nativeImage api cleanup (#41519) 
* docs: `nativeImage` api cleanup

* Update docs/api/native-image.md

* Update native-image.md

* Update docs/api/native-image.md

Co-authored-by: Felix Rieseberg <fr@makenotion.com>

* Update link to app icon

Co-authored-by: Alice Zhao <66543449+alicelovescake@users.noreply.github.com>

---------

Co-authored-by: Felix Rieseberg <fr@makenotion.com>
Co-authored-by: Alice Zhao <66543449+alicelovescake@users.noreply.github.com>
 2024-03-12 12:33:56 -04:00
Shelley Vohr
8eb580e79a
docs: note EXIF data unsupported in nativeImage (#41261) 
* docs: note EXIF data unsupported in nativeImage

* Update docs/api/native-image.md

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>

---------

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
 2024-02-08 14:59:46 +01:00
David Sanders
3d2a754531
chore: extend linting of code blocks in the docs (#40245) 
* chore: extend linting of code blocks in the docs

* chore: combine lint:markdownlint and lint:markdown scripts
 2023-11-21 16:50:08 +09:00
hunter
2b283724ce
docs: fix some string union type (#39258) 
* docs: fix some string union types

Improve Type Union Typings in the Docs

* test: add smoke tests

* test: update `ses.clearStorageData` test case

* test: update `ses.clearStorageData` test case

---------

Co-authored-by: mhli <mhli@hillinsight.com>
 2023-07-31 10:32:59 +02:00
David Sanders
4415b7638a
chore: enforce consistent Markdown style for strong and emphasis (#37787) 2023-04-03 13:20:10 +02:00
Erick Zhao
2ac9ff1f20
docs: change MSDN links to new Microsoft docs (#37603) 2023-03-21 11:39:19 -04:00
Shelley Vohr
8ee58e18fd
refactor: createThumbnailFromPath takes size not maxSize (#37362) 
refactor: createThumbnailFromPath takes size not maxSize
 2023-03-08 21:48:29 -05:00
Jeremy Rose
dd68fae081
test: migrate nativeImage specs to main (#35062) 
* test: move nativeImage specs to main

* simplify test
 2022-07-26 09:57:01 +02:00
Milan Burda
e6b1d95a1c
docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
Samuel Attard
81795744cf
fix: ensure the typescript definitions only export correct value types (#28712) 
* fix: ensure the typescript definitions only export correct value types

In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface).  The typescript compiler will let anything declared via const or class be used as a value.  Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want).

This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export.

Fixes #22167

* chore: update typescript-defs

* chore: update typescript-defs

* chore: fix bad typescript in IPC test

* docs: test rendering of new syntax

* chore: update per feedback, use same syntax but with 'this is not exportedd' line
 2021-06-15 13:50:31 -07:00
George Xu
beaf60de0a
feat: add nativeImage.createThumbnailFromPath API (#24802) 
* initial commit, mac implementation

* add documentation

* convert createThumbnailFromPath to async function

* windows impl protoype

* add tests

* added test

* fix

* fix test

* clean up

* update docs

* cleaning up code

* fix test

* retrigger CI

* retrigger CI

* refactor from app to native_image

* windows build

* lint

* lint

* add smart pointers, fix test

* change tests and update docs

* fix test, remove nolint

* add renderer-main process routing to fix tests

* lint

* thanks sam

* thanks sam
 2020-08-24 09:36:13 -07:00
Shelley Vohr
21a6062a31
docs: document optional scaleFactor param to nativeImage fns (#23671) 2020-05-20 18:52:48 -07:00
Shelley Vohr
674e4a9fdd
chore: more modules to dual prop/fn support (#22688) 2020-03-17 18:06:52 -07:00
Samuel Attard
c8ed22def3
docs: fix isMactemplateImage type definition (#21166) 2019-11-18 10:57:22 -08:00
pi1024e
0851697cb7 docs: fix punctuation errors in native-image.m (#19620) 
* Added correct punctuation to sentences in documentation as well as changed lets to consts to pass the docs linter

* Fixed inconsistent indentation
 2019-08-19 15:15:13 -07:00
Micha Hanselmann
af3316707f fix invalid lang tags (#19513) 2019-07-30 13:11:56 -07:00
Samuel Attard
f80601da16
docs: ensure that optionality matches between documented params and signatures (#18613) 
* docs: ensure that optionality matches between documented params and signatures

* docs: ensure that all optional declarations are lower case

* chore: fix broken link
 2019-06-04 14:03:24 -07:00
Shelley Vohr
1e3e5a6619
refactor: set appLevelAppearance prop on systemPreferences (#18477) 
* refactor: set appLevelAppearance prop on systemPreferences

* ensure backwards compat is tested
 2019-05-30 17:12:46 -07:00
Milan Burda
7e2cbf528e docs: link to better list of icons for nativeImage.createFromNamedImage() (#18336) 2019-05-18 22:00:08 +02:00
Shelley Vohr
02710ef574 refactor: make templateImage a property on nativeImage (#18124) 
* refactor: make templateImage a property on nativeImage

* Update docs/api/native-image.md

Co-Authored-By: codebytere <codebytere@github.com>

* fix nativeImage prototype deprecation

* update for new property name

* Update docs/api/native-image.md

Co-Authored-By: codebytere <codebytere@github.com>
 2019-05-07 06:52:07 -07:00
Samuel Attard
a96b6e2c96 build: move to the new docs parser (#18103) 
* build: move to the new docs parser

* chore: remove the bad getTitle param doc

* build: update parser/ts gen deps + fix some docs issues highlighted by GH desktop

* chore: apply suggestions from code review

Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>

* chore: update docs for accidentally removed things

* chore: update docs/api/command-line.md

Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>
 2019-05-06 08:29:01 -07:00
Shelley Vohr
f1ee35e281
doc: document occasional mismatch between NSImageName and string (#17826) 2019-04-17 15:06:51 -07:00
Milan Burda
878538f2e8 feat: add safer nativeImage.createFromBitmap(), which does not decode PNG/JPEG (#17337) 2019-03-14 11:00:38 -07:00
Samuel Attard
558fff69e7
chore: update to standard 12 2018-09-14 14:57:01 +10:00
pravdomil
fd6eeed5c4
clarify docs 2018-06-02 20:41:19 +02:00
Toinane
0a0d88a5dc
remove all double spaces not needed 2017-11-29 11:58:24 +01:00
Toinane
323ea2b27b
fix(docs): fix all missing dots and add some links 2017-11-29 11:38:35 +01:00
Samuel Attard
b5ba8699f3
Enable hsl shifting of named images 2017-10-10 17:05:13 +11:00
Samuel Attard
ec610cd97b Document new nativeImage.createFromNamedImage method 2017-10-10 03:16:24 +11:00
Samuel Attard
d84ddd7fe4 Fix createFromDataURL return type 
Fixes #9469
 2017-05-16 01:24:06 +10:00
Milan Burda
568454525d Use point / size / rectangle structures consistently in API docs 2017-04-04 08:31:09 +02:00
Kevin Sawicki
f19998ef4c Add more default values 2017-03-09 10:26:44 -08:00
Kevin Sawicki
089bfd2cd2 Document nativeImage.addRepresentation(options) 2017-03-09 09:56:42 -08:00
Kevin Sawicki
6d5fbe6be2 Document scale factor option 2017-03-07 12:27:55 -08:00
Zeke Sikelianos
e57cb713b2 link process annotations to glossary 2016-12-21 13:47:40 -08:00
Kevin Sawicki
98d4e186e3 Move details next to params 2016-12-14 10:19:38 -08:00
Kevin Sawicki
3b259b4243 Add createFromBuffer to planned breaking changes 2016-12-14 10:12:37 -08:00
gellert
7ceb8d1ab8 additional tests for createFromBuffer 2016-12-14 00:18:24 +01:00
gellert
a609e52a14 moves bitmap parameters to options object 2016-12-13 21:32:17 +01:00
gellert
39875c90f1 adds bitmap support to createFromBuffer 2016-12-13 21:32:17 +01:00
Zeke Sikelianos
4770d2b526 returns an instance, not the module 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
21105271a4 document processes for APIs nested in parent docs 2016-11-03 11:50:00 -07:00
Zeke Sikelianos
ac68de6215 document process(es) for all APIs 2016-11-03 10:26:00 -07:00
Kevin Sawicki
451cea4675 Add newline before list 2016-10-06 11:02:30 -07:00
Kevin Sawicki
4b95f3a462 Mark width/height as optional 2016-10-05 11:02:58 -07:00
Kevin Sawicki
abffd98e29 Resize images with preserve aspect ratio 2016-10-05 11:02:58 -07:00
Kevin Sawicki
56f9cc683a bounds -> rect 2016-10-05 11:02:57 -07:00
Kevin Sawicki
9fa13710aa Document crop and resize 2016-10-05 11:02:57 -07:00
Dave Jeffery
29b9fbcc9a Docs: Move buffer link to end of file 2016-10-04 21:34:24 +01:00